Skip to content

Commit

Permalink
Update docs about CI
Browse files Browse the repository at this point in the history
  • Loading branch information
sourcefrog committed Feb 16, 2025
1 parent 9b9463e commit 7e3fa09
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions book/src/ci.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,11 @@ The recommended way to install cargo-mutants is using [install-action](https://g

Here is an example of a GitHub Actions workflow that runs mutation tests and uploads the results as an artifact. This will fail if it finds any uncaught mutants.

The recommended way to install cargo-mutants is using [install-action](https://github.com/taiki-e/install-action), which will fetch a binary from cargo-mutants most recent GitHub release, which is faster than building from source. You could alternatively use [baptiste0928/cargo-install](https://github.com/baptiste0928/cargo-install) which will build it from source in your worker and cache the result.

```yml
{{#include ../../examples/workflows/basic.yml}}
```

The workflow used by cargo-mutants on itself can be seen at
<https://github.com/sourcefrog/cargo-mutants/blob/main/.github/workflows/mutate-self.yaml>, but this is different from what you will typically want to use, because it runs cargo-mutants from HEAD.

0 comments on commit 7e3fa09

Please sign in to comment.