-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
13 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -41,9 +41,12 @@ If omitted, the latest version of `Kani` hosted on [`Kani's crates.io page`](htt | |
|
||
## Example usage in a workflow YAML file: | ||
|
||
Here are a few examples of workflow YAML files for the Kani Github Action | ||
Here are a few examples of workflow YAML files for the Kani Github Action: | ||
|
||
#### Example 1: Default configuration | ||
|
||
Default config which uses the latest version of Kani to run `cargo-kani` on project in current directory. | ||
|
||
#### Example 1: Default config which uses the latest version of kani to run `cargo-kani` on project in current directory | ||
```yaml | ||
jobs: | ||
kani: | ||
|
@@ -53,7 +56,10 @@ jobs: | |
uses: model-checking/[email protected] | ||
``` | ||
#### Example 2: Use a specific version of kani, version `0.35.0`, to run `cargo-kani` on a project | ||
#### Example 2: Use pinned version of Kani | ||
Use a specific version of Kani, version `0.35.0`, to run `cargo-kani` on a project. | ||
|
||
```yaml | ||
jobs: | ||
kani: | ||
|
@@ -67,7 +73,10 @@ jobs: | |
working-directory: './path/to/project' | ||
``` | ||
|
||
#### Example 3: Use pinned version of kani, version `0.35.0`, to run `cargo-kani --tests` on a project with propproof harnesses. | ||
#### Example 3: Run Kani with args | ||
|
||
Use latest version of Kani, to run `cargo-kani --tests` on a project with `propproof` harnesses. | ||
|
||
```yaml | ||
jobs: | ||
kani: | ||
|
@@ -76,9 +85,6 @@ jobs: | |
- name: Run Kani | ||
uses: model-checking/[email protected] | ||
with: | ||
kani-version: '0.35.0' | ||
command: 'cargo-kani' | ||
working-directory: './path/to/project' | ||
args: '--tests' | ||
enable-propproof: true | ||
``` | ||
|