Skip to content

Docs: Update CONTRIBUTING.md with more specific release instructions. #1428

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

Merged
dbanty merged 2 commits into from
Feb 14, 2022
Merged

Docs: Update CONTRIBUTING.md with more specific release instructions. #1428

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4b5988a
Docs: Update CONTRIBUTING.md with more specific release instructions.
dbanty Feb 14, 2022
f184baa
Merge branch 'rc' into update-release-instructions
dbanty Feb 14, 2022
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
16 changes: 5 additions & 11 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,21 +339,15 @@ publishing Docker images, and running end-to-end tests on real QPUs.

### Release Process

Release is now automated through the use of Semantic Release. All development must occur on the `rc`
branch. For each push to this branch, a release candidate will be published to [GitHub][gh-releases],
[PyPI][pypi], and [DockerHub][docker-forest] (with image tags `rc` and `<version>`). When a final
release is desired, the `rc` branch should be merged to `master`. This will trigger a non-RC release
to [GitHub][gh-releases], [PyPI][pypi], and [DockerHub][docker-forest] (with image tags `latest` and
`<version>`).
Releases are now automated through the use of Semantic Release. All development must occur on the `rc` branch. For each push to this branch, a release candidate will be published to [GitHub][gh-releases], [PyPI][pypi], and [DockerHub][docker-forest] (with image tags `rc` and `<version>`).

After a final release is produced by Semantic Release, `master` will need to be `merged` back into `rc`
(due to additional `master` commits created by Semantic Release). This is necessary to re-synchronize
`rc` with `master` so that further development can continue on `rc`.
When a final release is desired, create a PR from `rc` to `master` and merge (via "Rebase" strategy is okay here, it fast forwards). Update `CHANGELOG.md` with the new to-be-released version number and push that to `master`. Then, in GitLab CI, trigger the manual release action to create a final release for [GitHub][gh-releases], [PyPI][pypi], and [DockerHub][docker-forest] (with image tags `latest` and `<version>`).

After a final release is produced by Semantic Release, `master` will need to be `merged` back into `rc` (due to additional `master` commits created by Semantic Release). This is necessary to re-synchronize `rc` with `master` so that further development can continue on `rc`. **USE A MERGE COMMIT** to do this only after the new version has been committed to master by Semantic Release.

> ⚠️ **WARNING**:
>
> Never rebase (or force-push to) the `rc` or `master` branches. Merge only, as Semantic Release
> relies heavily on tags and notes attached to previous release commits. See [this help page][sr-fp] for more info.
> Never change the history of (e.g., rebasing or force-pushing) the `rc` or `master` branches. Semantic Release relies heavily on tags and notes attached to previous release commits. See [this help page][sr-fp] for more info.

[sr-fp]: https://semantic-release.gitbook.io/semantic-release/support/troubleshooting#release-not-found-release-branch-after-git-push-force

Expand Down