Skip to content

Commit ae150e9

Browse files
authored
Minor clarifications to the release process documentation (#1575)
The main change here is putting the steps that need to be done after the release automation (bumping the version numbers) into list form like the previous steps so that they stand out and don't get lost in the text about the stable branch policy.
1 parent 131aff7 commit ae150e9

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -491,23 +491,27 @@ When it is time to release a new minor version of qiskit-experiments, we will:
491491
the main release notes file.
492492
2. Add a release notes prelude and any final release notes edits.
493493
3. Open a PR to `main` with the release notes updates.
494-
4. Create a new `X.Y.0` tag from `main` and push it to github.
494+
4. After merging the PR, create a new `X.Y.0` tag from `main` and push it to github.
495495

496496
The release automation processes will be triggered by the new tag and perform the
497497
following steps:
498498

499499
1. Create a stable branch for the new minor version from the release tag on the `main`
500500
branch
501501
2. Build and upload binary wheels to PyPI
502-
3. Create a github release page with a generated changelog
502+
3. Create a github release page with a generated changelog if changelog tags
503+
were used on pull requests. Usually, by hand we also edit in a top line to
504+
the GitHub Releases entry with a link to the documentation release notes page.
505+
506+
After the release automation creates the stable branch, the following steps
507+
should be performed:
508+
509+
1. Bump the version numbers in the `main` branch. This update can be done by
510+
running `tox run -ebumpversion` and then committing the resulting changes.
511+
2. Open and merge a pull request with the version bump changes.
503512

504513
The `stable/*` branches should only receive changes in the form of bug fixes.
505514
If you're making a bug fix PR that you believe should be backported to the
506515
current stable release, tag it with `backport stable potential`. Producing a
507516
new patch releaes can be done just by adding a new tag to the `stabel/*` to
508517
trigger the release automation.
509-
510-
After a new release is tagged and the automation runs, the version numbers in
511-
the `main` branch should be updated. This update can be done by running `tox
512-
run -ebumpversion` and then committing the resulting changes.
513-

0 commit comments

Comments
 (0)