Add clarity to backport release docs #3640
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Jkovarik
reviewed
May 1, 2024
docs/development/release.md
Outdated
| @@ -323,6 +323,14 @@ If this is a new minor version branch, then you will need to create a new Bamboo | |||
|
|
|||
| Bamboo will build and run lint and unit tests against that tagged release, publish the new packages to NPM, and then run the integration tests using those newly released packages. | |||
|
|
|||
| :::caution important | |||
|
|
|||
| If this is a backport release, you **must** run the `master` branch in Bamboo immediately after the backport release is published. This is because the release process will overwrite the Cumulus documentation with the backport branch and will remove current versions. Running `master` will restore the current doc versions. | |||
There was a problem hiding this comment.
This is a good backstop, but it's much quicker to revert the doc updates commit and push. We should discuss this further.
There was a problem hiding this comment.
Yeah what do you think about this: f9a12b7
I kept "running main" as an option but inserted the quicker "revert the pages commit" before.
|
@npauzenga this should probably include details re: commit reverts in the gh-pages branch. |
|
@npauzenga just noted I'm a reviewer on this. Are we going to keep this going? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a note about running main after a backport to restore current doc versions. There are more clever solutions here that involve updating our CI scripts. This is a stopgap.