Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add notice to README on main #50

Merged
merged 5 commits into from
Sep 28, 2023
Merged

Add notice to README on main #50

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1db5fb8
Add notice to main
jaisnan Sep 27, 2023
e8ef6fb
Merge branch 'main' into Add-notice-to-readme-main
jaisnan Sep 27, 2023
9741512
Apply suggestions from code review
jaisnan Sep 28, 2023
ae12dfe
Address comments
jaisnan Sep 28, 2023
57f7dbe
Remove backticks
jaisnan Sep 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,26 @@

This repository provides a GitHub Action for running the [Kani Rust Verifier](https://github.com/model-checking/kani) in CI.

⚠️ **Important Notice**: We will be moving to [`v1`](https://github.com/model-checking/kani-github-action/releases/tag/v1.0), which will install the latest version of `Kani` by default.
Please be aware that version `0.38` will be the final release where the version of `Kani` matches the version of `Kani Github Action`.
Make sure to update your workflows and references accordingly.
To install a specific version of `Kani`, please add a semver version to the field `kani-version` as shown in the example below.
jaisnan marked this conversation as resolved.
Show resolved Hide resolved

Example:

```
jobs:
kani:
runs-on: ubuntu-latest
steps:
- name: Run Kani
uses: model-checking/kani-github-action@v1
with:
kani-version: '0.35.0'
command: 'cargo-kani'
working-directory: './path/to/project'
```

## Security

See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
Expand All @@ -10,4 +30,3 @@ See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more inform

This code is distributed under the terms of both the MIT license and the Apache License (Version 2.0).
See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for details.

Loading