Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2024-12-24 23:19:39 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: minor adjustements to the release docs (#1384)

Browse Source
This commit is contained in:
Otto Bittner 2023-03-09 18:03:47 +01:00 committed by GitHub
parent dc4769d0a0
commit b356af5a39
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
dev-docs/workflows/release.md
View File

@ -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 gh workflow run release.yml --ref release/v$minor -F version=$ver -F kind=patch
``` ```
3. wait for the pipeline to finish 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 ### Minor release
1. Merge ready PRs 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 gh workflow run release.yml --ref main -F version=$ver -F kind=minor
``` ```
3. wait for the pipeline to finish 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 ## 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. 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. 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 ### GCP
1. Navigate to [Images](https://console.cloud.google.com/compute/images?tab=images&project=constellation-images) tab of the "constellation-images" project 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" 2. Search for the image version "v1-3-0-stable"