Skip to content

Commit

Permalink
dev-docs: fix instructions in release docs (#2611)
Browse files Browse the repository at this point in the history
  • Loading branch information
msanft authored Nov 17, 2023
1 parent 5e9e3de commit ce51848
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
2 changes: 1 addition & 1 deletion dev-docs/howto/longhorn.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Longhorn on Constellatioin

To build Longhorn compatible images, apply the following changes. Those stem from [their installation guide](https://longhorn.io/docs/1.3.2/deploy/install/#installation-requirements).
To build Longhorn compatible images, apply the following changes. Those stem from [their installation guide](https://longhorn.io/docs/1.5.3/deploy/install/#installation-requirements).

```diff
diff --git a/image/mkosi.conf.d/azure.conf b/image/mkosi.conf.d/azure.conf
Expand Down
7 changes: 4 additions & 3 deletions dev-docs/workflows/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,9 @@ Releases should be performed using [the automated release pipeline](https://gith
5. Check the s3proxy PR in the [helm chart repository](https://github.com/edgelesssys/helm/pull/) and approve it if things (esp. the version) look correct. Correct example for reference: https://github.com/edgelesssys/helm/pull/19/files
6. while in editing mode for the release, clear the textbox, select the last minor release and click "Generate release notes".
7. 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. The changelog should be primarily aimed at users. Rule of thumb: first part of the sentence should describe what changed for the user, second part can describe what has been changed to achieve this.
8. in the GitHub release UI, set the tag to create on publish to `$ver`.
9. publish.
8. set the Target to `tmp/${ver}`
9. in the GitHub release UI, set the tag to create on publish to `$ver`.
10. publish.

## Post release steps

Expand All @@ -88,7 +89,7 @@ Releases should be performed using [the automated release pipeline](https://gith
4. Move open issues and PRs from closed milestone to next milestone
3. If the release is a minor version release, bump the pre-release version in the `version.txt` file.
4. Update the `fromVersion` in `e2e-test-release.yml` and `e2e-test-weekly.yaml` to the newly released version. To check the current values, run: `grep "fromVersion: \[.*\]" -R .github`.
5. Reset `upgradeRequiresIAMMigration` in `iamupgradeapply.go`.
5. Reset `UpgradeRequiresIAMMigration` in [`iamupgrade.go`](https://github.com/edgelesssys/constellation/blob/a88a731576184e3c5ee8527741c4a0cdaa4e9b24/cli/internal/cloudcmd/iamupgrade.go#L23).

## Troubleshooting: Pipeline cleanup

Expand Down

0 comments on commit ce51848

Please sign in to comment.