From e62ef14fd8906966bfe17ec42f6e15da4bc9bddf Mon Sep 17 00:00:00 2001 From: Eddie Webbinaro Date: Thu, 2 May 2024 12:30:59 -0400 Subject: [PATCH] Update continuous-integration.md: Include CircleCI reference Adds simple example to run `cargo test` on CircleCI --- src/doc/src/guide/continuous-integration.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/src/doc/src/guide/continuous-integration.md b/src/doc/src/guide/continuous-integration.md index fcbe0afc12c..d9f14de9b41 100644 --- a/src/doc/src/guide/continuous-integration.md +++ b/src/doc/src/guide/continuous-integration.md @@ -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