Skip to content

Commit

Permalink
Improve release pipeline (#135)
Browse files Browse the repository at this point in the history
* use GITHUB_TOKEN for GitHub actions
* revise release checklist

Signed-off-by: Shiwei Zhang <[email protected]>
  • Loading branch information
shizhMSFT authored Nov 19, 2021
1 parent b16b2b4 commit 1e9144c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 10 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/release-github.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ jobs:
version: latest
args: release --rm-dist
env:
GITHUB_TOKEN: ${{ secrets.RELEASE_GITHUB_USER_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
14 changes: 5 additions & 9 deletions RELEASE_CHECKLIST.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,8 @@ This document describes the checklist to publish a release via GitHub workflow.
1. Determine a [SemVer2](https://semver.org/)-valid version prefixed with the letter `v` for release. For example, `version="v1.0.0-alpha.1"`.
2. Bump up the `Version` in [internal/version/version.go](internal/version/version.go#L5) and open a PR for the changes.
3. Wait for the PR merge.
4. Generate a GitHub [personal access token (PAT)](https://github.com/settings/tokens/new) with the `repo:public_repo` permission.
5. In the repository `Settings -> Secrets`, create or update the repository secret `RELEASE_GITHUB_USER_TOKEN` with the PAT generated above.
6. Make a fresh clone of the repository, check the `git log`, and create a tag by `git tag $version`.
7. After double checking the digest of the tag, push the tag directly to the repository by `git push origin $version`.
8. Wait for the completion of the GitHub action `release-github`.
9. Revoke the PAT generated previously.
10. Delete or update the repository secret `RELEASE_GITHUB_USER_TOKEN` with a dummy value.
11. Check the new release, and revise the release description.
12. Announce the release in the community.
4. Make a fresh clone of the repository, check the `git log`, and create a tag by `git tag $version`.
5. After double checking the digest of the tag, push the tag directly to the repository by `git push origin $version`.
6. Wait for the completion of the GitHub action `release-github`.
7. Check the new draft release, revise the release description, and publish the release.
8. Announce the release in the community.

0 comments on commit 1e9144c

Please sign in to comment.