Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
Signed-off-by: Junjie Gao <[email protected]>
  • Loading branch information
JeyJeyGao committed Jan 31, 2024
1 parent 837637b commit 1f523e6
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 6 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,31 @@ Before you begin, make sure the latest version of the [Notation CLI has been ins

For Notation >= v1.1.0, please use [notation plugin install](https://github.com/notaryproject/notation/blob/v1.1.0/specs/commandline/plugin.md#notation-plugin-install) command to automatically install azure-kv plugin.

For Linux amd64:
```
notation plugin install --url https://github.com/Azure/notation-azure-kv/releases/download/v1.0.2/notation-azure-kv_1.0.2_linux_amd64.tar.gz --sha256sum f2b2e131a435b6a9742c202237b9aceda81859e6d4bd6242c2568ba556cee20e
```

For Linux arm64:
```
notation plugin install --url https://github.com/Azure/notation-azure-kv/releases/download/v1.0.2/notation-azure-kv_1.0.2_linux_arm64.tar.gz --sha256sum 05cb2ca3460d07841f69b25d56fc7c93afe333b6b46ce33882a599cf0af9d532
```

For Windows amd64:
```
notation plugin install --url https://github.com/Azure/notation-azure-kv/releases/download/v1.0.2/notation-azure-kv_1.0.2_windows_amd64.zip --sha256sum 47769106233f9a4f34abed67d0ad6154ddee0e45b31c52127c23c52302970496
```

For macOS amd64:
```
notation plugin install --url https://github.com/Azure/notation-azure-kv/releases/download/v1.0.2/notation-azure-kv_1.0.2_darwin_amd64.tar.gz --sha256sum 9dfc197b2d03e2f0470c62997434cf6fa78476cc1364527025fe8a86acda94e3
```

For macOS arm64:
```
notation plugin install --url https://github.com/Azure/notation-azure-kv/releases/download/v1.0.2/notation-azure-kv_1.0.2_darwin_arm64.tar.gz --sha256sum ebc53b7ef1c32fb9d4ea7b85d30875b4595893d310a3ad7facfb333f55d5c3ed
```

**Manually install**:

For Linux Bash:
Expand Down
12 changes: 6 additions & 6 deletions RELEASE_CHECKLIST.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ This document describes the checklist to publish a release via GitHub workflow.

## Release Process
1. Determine a [SemVer2](https://semver.org/)-valid version prefixed with the letter `v` for release. For example, `version="v1.0.0-rc.1"`.
2. Submit a PR to update the `version` in `README.md` and wait approval for merging.
3. Be on the main branch connected to the actual repository (not a fork) and `git pull`. Ensure `git log -1` shows the latest commit on the main branch.
4. Create a tag `git tag -am $version $version`
5. `git tag` and ensure the name in the list added looks correct, then push the tag directly to the repository by `git push --follow-tags`.
6. Wait for the completion of the GitHub action [release-github](https://github.com/Azure/notation-azure-kv/actions/workflows/release.yml).
7. Check the new draft release, revise the release description, and publish the release.
2. Be on the main branch connected to the actual repository (not a fork) and `git pull`. Ensure `git log -1` shows the latest commit on the main branch.
3. Create a tag `git tag -am $version $version`
4. `git tag` and ensure the name in the list added looks correct, then push the tag directly to the repository by `git push --follow-tags`.
5. Wait for the completion of the GitHub action [release-github](https://github.com/Azure/notation-azure-kv/actions/workflows/release.yml).
6. Check the new draft release, revise the release description, and publish the release.
7. Submit a PR to update the `version` and `sha256sum` in `README.md` and wait approval for merging.
8. Announce the release in the community.

0 comments on commit 1f523e6

Please sign in to comment.