Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add clarity to backport release docs #3640

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

npauzenga
Copy link
Contributor

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.

@@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good backstop, but it's much quicker to revert the doc updates commit and push. We should discuss this further.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah what do you think about this: f9a12b7

I kept "running main" as an option but inserted the quicker "revert the pages commit" before.

@Jkovarik
Copy link
Member

Jkovarik commented May 1, 2024

@npauzenga this should probably include details re: commit reverts in the gh-pages branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants