Skip to content

Commit f4a08b8

Browse files
chore: update RELEASING.md
Signed-off-by: Mathew Wicks <[email protected]>
1 parent eccfdff commit f4a08b8

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

RELEASING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,19 @@
33
This guide is intended for maintainers who want to make a new release of the deployKF CLI.
44

55
1. For a new minor or major release, create a `release-*` branch first.
6-
- For example, for the `v0.2.0` release, create a new branch called `release-0.2`.
6+
- For example, for the `v0.2.0` release, create a new branch called `release-0.2`.
77
- This allows for the continued release of bug fixes to older versions.
88
2. Create a new tag on the appropriate release branch for the version you are releasing.
99
- For instance, you might create `v0.1.1` or `v0.1.1-alpha.1` on the `release-0.1` branch.
1010
- Ensure you ONLY create tags on the `release-*` branches, not on the `main` branch.
11-
- Remember to sign the tag with your GPG key.
11+
- Remember to sign the tag with your GPG key.
1212
- You can do this by running `git tag -s v0.1.1 -m "v0.1.1"`.
1313
- You can verify the tag signature by running `git verify-tag v0.1.1`.
1414
- Ensure you ONLY push the specific tag you want to release.
1515
- For example, if you want to release `v0.1.1`, you should run `git push origin v0.1.1`.
1616
- Do NOT run `git push origin --tags` or `git push origin main`.
17-
3. When a new semver tag is created, a workflow will automatically create a GitHub draft release.
18-
- The release will include the binaries and corresponding SHA256 checksums for all supported platforms.
19-
- Don't forget to add a changelog to the release description.
20-
- You can use the "generate release notes" feature of GitHub to help you with this.
21-
4. Manually publish the draft release.
17+
- When a new semver tag is created, a workflow will automatically create a GitHub draft release.
18+
- The release will include the binaries and corresponding SHA256 checksums for all supported platforms.
19+
3. Generate the changelog using the "generate release notes" feature of GitHub and set it as the release description.
20+
4. When ready to ship, manually publish the draft release.
21+
5. Update the changelog on the website using the [`update_changelogs.sh`](https://github.com/deployKF/website/blob/main/update_changelogs.sh) script.

0 commit comments

Comments
 (0)