Skip to content

Commit

Permalink
Auto merge of #13850 - eddiewebb:patch-1, r=epage
Browse files Browse the repository at this point in the history
Update continuous-integration.md: Include CircleCI reference

### What does this PR try to resolve?

Adds simple example to run `cargo test` on CircleCI, alongside the other popular CI engines.

### How should we test and review this PR?

Change is purely documentation. I would ask that the PR be checked for tone and formatting that is in line with Rust/Cargo community standards.
  • Loading branch information
bors committed May 2, 2024
2 parents 1a0e77f + e62ef14 commit f892647
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions src/doc/src/guide/continuous-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,25 @@ channel, but any breakage in nightly will not fail your overall build. Please
see the [builds.sr.ht documentation](https://man.sr.ht/builds.sr.ht/) for more
information.


### CircleCI

To test your package on CircleCI, here is a sample `.circleci/config.yml` file:

```yaml
version: 2.1
jobs:
build:
docker:
# check https://circleci.com/developer/images/image/cimg/rust#image-tags for latest
- image: cimg/rust:1.77.2
steps:
- checkout
- run: cargo test
```

To run more complex pipelines, including flaky test detection, caching, and artifact management, please see [CircleCI Configuration Reference](https://circleci.com/docs/configuration-reference/).

## Verifying Latest Dependencies

When [specifying dependencies](../reference/specifying-dependencies.md) in
Expand Down

0 comments on commit f892647

Please sign in to comment.