Skip to content

Commit

Permalink
Update RELEASE.md doc (#6645)
Browse files Browse the repository at this point in the history
* Update RELEASE.md docs

* Lint
  • Loading branch information
fayzal-g authored Nov 13, 2023
1 parent 9ba1c9d commit f6677bf
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,12 @@ the new release branch (prepare-release-X.Y -> release-X.Y):

1. Make sure you've a GPG key associated with your GitHub account (`git tag` will be signed with that GPG key)
- You can add a GPG key to your GitHub account following [this procedure](https://help.github.com/articles/generating-a-gpg-key/)
- You may run into:
```
error: gpg failed to sign the data
error: unable to sign the tag
```
- Follow the steps [here](https://docs.github.com/en/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key#telling-git-about-your-gpg-key) to tell Git about your GPG key.
1. Update the version number in the `VERSION` file to say `X.Y-rc.0`
1. Update `CHANGELOG.md`
- Ensure changelog entries for the new release are in this order:
Expand Down Expand Up @@ -210,6 +216,9 @@ To publish a release candidate:
```bash
git checkout release-<version>
# Ensure you are authenticated and there is not a stale token in the GITHUB_TOKEN environment variable
gh auth login
# Then run the following script and follow the instructions:
./tools/release/create-draft-release.sh
```
Expand Down

0 comments on commit f6677bf

Please sign in to comment.