From 1db5fb8b99dd6d21499c4c2a93be3a95df488591 Mon Sep 17 00:00:00 2001 From: jaisnan Date: Wed, 27 Sep 2023 18:17:49 -0400 Subject: [PATCH 1/4] Add notice to main --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 13d74b9..024057f 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,27 @@ This repository provides a GitHub Action for running the [Kani Rust Verifier](https://github.com/model-checking/kani) in CI. +⚠️ **Important Notice**: We will soon be moving the default branch from `main` to [`v1`](https://github.com/model-checking/kani-github-action/releases/tag/v1.0). +Please be aware that version `0.38` will be the final release on the `main` branch before the transition to stable. +Make sure to update your workflows and references accordingly. +We have added a new field called `kani-version` that will default to installing the latest version of `kani`. +To install a specific version of 'kani', please add a semver version to the field `kani-version` as shown in the example below. + +Example: + +``` +jobs: + kani: + runs-on: ubuntu-latest + steps: + - name: Run Kani + uses: model-checking/kani-github-action@v1.0 + 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. @@ -10,4 +31,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. - From 974151251f6f3fb26d84bdad46fae4fb0ebb25d2 Mon Sep 17 00:00:00 2001 From: Jaisurya Nanduri <91620234+jaisnan@users.noreply.github.com> Date: Thu, 28 Sep 2023 10:04:52 -0400 Subject: [PATCH 2/4] Apply suggestions from code review Add suggestions from review Co-authored-by: Celina G. Val --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 024057f..fc42c77 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ This repository provides a GitHub Action for running the [Kani Rust Verifier](https://github.com/model-checking/kani) in CI. ⚠️ **Important Notice**: We will soon be moving the default branch from `main` to [`v1`](https://github.com/model-checking/kani-github-action/releases/tag/v1.0). -Please be aware that version `0.38` will be the final release on the `main` branch before the transition to stable. +Please be aware that version `0.38` will be the final release on the `main` branch before the transition to `v1`. Make sure to update your workflows and references accordingly. We have added a new field called `kani-version` that will default to installing the latest version of `kani`. To install a specific version of 'kani', please add a semver version to the field `kani-version` as shown in the example below. @@ -16,7 +16,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Run Kani - uses: model-checking/kani-github-action@v1.0 + uses: model-checking/kani-github-action@v1 with: kani-version: '0.35.0' command: 'cargo-kani' From ae12dfe40915adc0d592ad00e9ac85f06c3cd5d3 Mon Sep 17 00:00:00 2001 From: jaisnan Date: Thu, 28 Sep 2023 10:48:59 -0400 Subject: [PATCH 3/4] Address comments --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index fc42c77..a00cf5e 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,10 @@ This repository provides a GitHub Action for running the [Kani Rust Verifier](https://github.com/model-checking/kani) in CI. -⚠️ **Important Notice**: We will soon be moving the default branch from `main` to [`v1`](https://github.com/model-checking/kani-github-action/releases/tag/v1.0). -Please be aware that version `0.38` will be the final release on the `main` branch before the transition to `v1`. +⚠️ **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. -We have added a new field called `kani-version` that will default to installing the latest version of `kani`. -To install a specific version of 'kani', please add a semver version to the field `kani-version` as shown in the example below. +To install a specific version of `Kani`, please add a semver version to the field `kani-version` as shown in the example below. Example: From 57f7dbe01f3191a38198b1f54a399d31426fd475 Mon Sep 17 00:00:00 2001 From: jaisnan Date: Thu, 28 Sep 2023 11:07:39 -0400 Subject: [PATCH 4/4] Remove backticks --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a00cf5e..08ffbab 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,10 @@ 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`. +⚠️ **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. +To install a specific version of Kani, please add a semver version to the field `kani-version` as shown in the example below. Example: