Kani offers a GitHub Action for running Kani in CI. As of now, only Ubuntu 20.04 with x86_64-unknown-linux-gnu
is supported for Kani in CI.
Our GitHub Action is available in the GitHub Marketplace.
The following workflow snippet will checkout your repository and run cargo kani
on it whenever a push or pull request occurs. Replace <MAJOR>.<MINOR>
with the version of Kani you want to run with.
name: Kani CI
on:
pull_request:
push:
jobs:
run-kani:
runs-on: ubuntu-20.04
steps:
- name: 'Checkout your code.'
uses: actions/checkout@v3
- name: 'Run Kani on your code.'
uses: model-checking/kani-github-action@v<MAJOR>.<MINOR>
This will run cargo kani
on the code you checked out.
The action takes the following optional parameters:
command
: The command to run. Defaults to cargo kani
. Most often, you will not need to change this.working-directory
: The directory to execute the command in. Defaults to .
. Useful if your repository has multiple crates, and you only want to run on one of them.args
: The arguments to pass to the given ${command}
. See cargo kani --help
for a full list of options. Useful options include:
--output-format=terse
to generate terse output.--tests
to run on proofs inside the test
module (needed for running Bolero).--workspace
to run on all crates within your repository.RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4