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.

Sign up for GitHub

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

Jump to bottom

Add clarity to backport release docs #3640

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

Add clarity to backport release docs #3640

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
621dbfd
Add clarity to backport release docs
npauzenga May 1, 2024
f9a12b7
Update docs with an additional option for backports
npauzenga May 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/development/release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,6 +323,17 @@ 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, the current documentation will be overwritten when the Bamboo job completes. To restore the current docs version you have two options:

1. Revert the commit associated with the backport on the `gh-pages` branch and push. The documentation build process will then update and reflect the correct current version of the docs.
2. run the `master` branch in Bamboo immediately after the backport release is published. Running `master` will restore the current doc versions but takes longer than option 1.

If the backport branch contains documentation changes, `master` should be run **after** merging the minor version release branch back into `master`. This will happen normally when a PR is submitted to merge the changes to `master` and CI successfully runs.

:::

### 12. Create a new Cumulus release on github

The CI release scripts will automatically create a GitHub release based on the release version tag, as well as upload artifacts to the Github release for the Terraform modules provided by Cumulus. The Terraform release artifacts include:
Expand Down