Skip to content

Commit

Permalink
Update release procedure
Browse files Browse the repository at this point in the history
- Add notes for patch releases
- Add missing step for whats_new* files
- Reformat one step
  • Loading branch information
msimberg committed Feb 19, 2019
1 parent edb02d1 commit cf8430d
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions docs/sphinx/contributing/release_procedure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ are completed to avoid confusion.

#. Write release notes in ``docs/sphinx/releases/whats_new_$VERSION.rst``. Keep
adding merged PRs and closed issues to this until just before the release is
made.
made. Add the new release notes to the table of contents in
``docs/sphinx/releases.rst``.

#. Build the docs, and proof-read them. Update any documentation that may have
changed, and correct any typos. Pay special attention to:
Expand Down Expand Up @@ -67,7 +68,8 @@ are completed to avoid confusion.
be deleted and recreated.

#. Delete the old release branch, and create a new one by branching a stable
point from master.
point from master. If you are creating a patch release, branch from the
release tag for which you want to create a patch release.

* ``git push origin --delete release``
* ``git branch -D release``
Expand All @@ -87,7 +89,7 @@ are completed to avoid confusion.
#. Remove features which have been deprecated for at least 2 releases. This
involves removing build options which enable those features from the main
CMakeLists.txt and also deleting all related code and tests from the main
source tree.
source tree. This step does not apply to patch releases.

The general deprecation policy involves a three-step process we have to go
through in order to introduce a breaking change
Expand Down Expand Up @@ -119,8 +121,8 @@ are completed to avoid confusion.

#. Allow at least a week for testing of the release candidate.

* Use ``git merge`` when possible, and fall back to ``git cherry-pick``
when needed.
* Use ``git merge`` when possible, and fall back to ``git cherry-pick`` when
needed.
* Repeat by tagging a new release candidate as many times as needed.

#. Checkout the release branch, and replace the ``-rcN`` tag in
Expand Down

0 comments on commit cf8430d

Please sign in to comment.