🌱 Added instructions to releasing.md (#1320)

syself · May 23, 2024 · 9fe1263 · 9fe1263
1 parent bd1a60b
commit 9fe1263
Showing 1 changed file with 4 additions and 5 deletions.
diff --git a/docs/developers/releasing.md b/docs/developers/releasing.md
@@ -5,7 +5,7 @@
 1. Create an annotated tag
    - `git switch main`
    - `git pull`
-   - Have a look at the current (old) version: [Github Releases](https://github.com/syself/cluster-api-provider-hetzner/releases) 
+   - Have a look at the current (old) version: [Github Releases](https://github.com/syself/cluster-api-provider-hetzner/releases)
    - `export RELEASE_TAG=<the tag of the release to be cut>` (eg. `export RELEASE_TAG=v1.0.1`)
    - `git tag -a ${RELEASE_TAG} -m ${RELEASE_TAG}`
 2. Push the tag to the GitHub repository.
@@ -15,7 +15,7 @@
 
 ## Release in GitHub
 
-1. Review the draft release on GitHub. Pay close attention to the `## :question: Sort these by hand` section, as it contains items that need to be manually sorted.
+1. Review the draft release on GitHub: [Releases](https://github.com/syself/cluster-api-provider-hetzner/releases). Use the pencil-icon to edit the draft release. Then use the button "Generate release notes". Pay close attention to the `## :question: Sort these by hand` section, as it contains items that need to be manually sorted. Feel free to move less important PRs, like version upgrades (from renovate bot), to the bottom.
 1. If it is pre-release, activate the corresponding check at the bottom of the page. And add `:rotating_light: This is a RELEASE CANDIDATE. If you find any bugs, file an [issue](https://github.com/syself/cluster-api-provider-hetzner/issues/new).` at the top of the release notes.
 1. Before publishing you can check the [Recent tagged image versions](https://github.com/syself/cluster-api-provider-hetzner/pkgs/container/caph): "latest" should be some seconds old and the new version number.
 1. Publish the release
@@ -31,7 +31,6 @@ This is only needed if you want to manually release images.
 2. Do:
    - `make release-image`
 
-
 ### Versioning
 
 See the [versioning documentation](./../../CONTRIBUTING.md#versioning) for more information.
@@ -40,5 +39,5 @@ See the [versioning documentation](./../../CONTRIBUTING.md#versioning) for more
 
 Releasing requires a particular set of permissions.
 
-* Tag push access to the GitHub repository
-* GitHub Release creation access
+- Tag push access to the GitHub repository
+- GitHub Release creation access