diff --git a/dev-docs/workflows/release.md b/dev-docs/workflows/release.md index 22f104503..1fcff362a 100644 --- a/dev-docs/workflows/release.md +++ b/dev-docs/workflows/release.md @@ -23,8 +23,9 @@ Releases should be performed using [the automated release pipeline](https://gith gh workflow run release.yml --ref release/v$minor -F version=$ver -F kind=patch ``` 3. wait for the pipeline to finish -4. look over the autogenerated draft release and publish it - +4. while in editing mode for the release, clear the textbox, select the last patch release for the current release branch and click "Generate release notes". +5. look over the autogenerated draft release. When fixing the changelog, prioritize updating the PR title/labels/description and regenerating the changelog over fixing things in the final changelog. +6. publish. ### Minor release 1. Merge ready PRs @@ -35,7 +36,9 @@ Releases should be performed using [the automated release pipeline](https://gith gh workflow run release.yml --ref main -F version=$ver -F kind=minor ``` 3. wait for the pipeline to finish -4. look over the autogenerated draft release and publish it +4. while in editing mode for the release, clear the textbox, select the last minor release and click "Generate release notes". +5. look over the autogenerated draft release. When fixing the changelog, prioritize updating the PR title/labels/description and regenerating the changelog over fixing things in the final changelog. +6. publish. ## Post release steps @@ -60,6 +63,13 @@ Releases should be performed using [the automated release pipeline](https://gith When testing changes to the pipeline or when the pipeline fails during a release it might become necessary to clean up the images created by the pipeline. These are the necessary steps. +### General + +Depending on how far the pipeline ran we need to delete: +- the release tag create by the pipeline: `v1.3.0`/`v1.3.1` +- (only minor releases) the branch to merge changes back to main: `feat/release/v1.3.0` + + ### GCP 1. Navigate to [Images](https://console.cloud.google.com/compute/images?tab=images&project=constellation-images) tab of the "constellation-images" project 2. Search for the image version "v1-3-0-stable"