Commit 098dcf05 authored by Paul McCarthy's avatar Paul McCarthy 🚵
Browse files

Merge branch 'mnt/release' into 'master'

Mnt/release

See merge request fsl/fslpy!195
parents f5d6cae7 66e55025
Pipeline #4957 passed with stages
in 14 minutes and 9 seconds
......@@ -2,8 +2,8 @@ This document contains the ``fslpy`` release history in reverse chronological
order.
2.8.1 (Under development)
-------------------------
2.8.1 (Thursday 20th February 2020)
-----------------------------------
Fixed
......
......@@ -67,9 +67,9 @@ numbers::
The version number in the ``master`` branch should be of the form
``major.minor.patch.dev``, to indicate that any releases made from this branch
are development releases (although development releases are not part of the
release model).
``major.minor.patch.dev0``, to indicate that any releases made from this
branch are development releases (although development releases are not part of
the release model).
Releases
......@@ -94,6 +94,44 @@ example, the first release off the ``v1.0`` branch would be tagged with
``1.0.1``, ``1.0.2``, etc.
Major/minor releases
^^^^^^^^^^^^^^^^^^^^
Follow this process for major and minor releases. Steps 1 and 2 should be
performed via a merge request onto the master branch, and step 4 via a merge
request onto the relevant minor branch.
1. Update the changelog on the master branch to include the new version number
and release date.
2. On the master branch, update the version number in ``fsl/version.py`` to
a development version of **the next** minor release number. For example,
if you are about to release version ``1.3.0``, the version in the master
branch should be ``1.4.0.dev0``.
3. Create the new minor release branch off the master branch.
4. Update the version number on the release branch. If CI tests fail on the
release branch, postpone the release until they are fixed.
5. Tag the new release on the minor release branch.
Bugfix/patch releases
^^^^^^^^^^^^^^^^^^^^^
Follow this process for patch releases. Step 1 should be performed via
a merge request onto the master branch, and step 2 via a merge request onto
the relevant minor branch.
1. Add the fix to the master branch, along with an updated changelog including
the version number and date for the bugfix release.
2. Cherry-pick the relevant commit(s) from the master branch onto the minor
release branch, and update the version number on the minor release branch.
If CI tests fail on the release branch, go back to step 1.
3. Tag the new release on the minor release branch.
Testing
-------
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment