diff --git a/RELEASE_CHECKLIST.md b/RELEASE_CHECKLIST.md new file mode 100644 index 00000000..bcb22f08 --- /dev/null +++ b/RELEASE_CHECKLIST.md @@ -0,0 +1,14 @@ +# Release Checklist + +## Overview + +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. 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. Announce the release in the community. diff --git a/scripts/release.sh b/scripts/release.sh index 343a99a3..c94949ed 100755 --- a/scripts/release.sh +++ b/scripts/release.sh @@ -44,6 +44,7 @@ for runtime in "${runtimes[@]}"; do mapped_runtime="${runtime/x64/amd64}" mapped_runtime="${mapped_runtime/win/windows}" mapped_runtime="${mapped_runtime/osx/darwin}" + mapped_runtime="${mapped_runtime/-/_}" artifact_name="${artifacts_dir}/${project_name}_${version}_${mapped_runtime}.${ext}" binary_dir="$output_dir/$runtime"