Skip to content
Snippets Groups Projects
Commit 10c13402 authored by Martyn Gigg's avatar Martyn Gigg
Browse files

Update release branch name in dev docs

parent 737b1160
No related branches found
No related tags found
No related merge requests found
...@@ -85,7 +85,7 @@ When creating a pull request you should: ...@@ -85,7 +85,7 @@ When creating a pull request you should:
- The title should **not** contain the issue number - The title should **not** contain the issue number
- `Reference the issue which the pull request is closing <https://github.com/blog/1506-closing-issues-via-pull-requests>`_, using one of `these <https://help.github.com/articles/closing-issues-via-commit-messages>`_ keywords - `Reference the issue which the pull request is closing <https://github.com/blog/1506-closing-issues-via-pull-requests>`_, using one of `these <https://help.github.com/articles/closing-issues-via-commit-messages>`_ keywords
- State the user and facility (if relevant) who initiated the original issue, if they are named in the issue. Please do not put full email addresses on the Pull Request, as it is publicly accessible. - State the user and facility (if relevant) who initiated the original issue, if they are named in the issue. Please do not put full email addresses on the Pull Request, as it is publicly accessible.
If the user would not be easily identified by someone picking up the ticket, be prepared to act as a point of contact with the reporter. If the user would not be easily identified by someone picking up the ticket, be prepared to act as a point of contact with the reporter.
- Ensure the description follows the format described by the `PR - Ensure the description follows the format described by the `PR
template template
...@@ -128,8 +128,7 @@ Code Freeze ...@@ -128,8 +128,7 @@ Code Freeze
^^^^^^^^^^^ ^^^^^^^^^^^
At the start of a *code freeze* before a major release there will be a At the start of a *code freeze* before a major release there will be a
release branch created with the name ``release-vX.Y``, where ``X.Y`` release branch created named ``release-next``. At this point
are the major and minor version numbers, respectively. At this point
only bugfixes should be applied to this release branch so that it can only bugfixes should be applied to this release branch so that it can
be stabilized for the release. The release branch will be merged to be stabilized for the release. The release branch will be merged to
``master`` periodically so bugfixes do not need to be separately ``master`` periodically so bugfixes do not need to be separately
...@@ -143,7 +142,7 @@ created from the correct base branch depending on the scope of the ...@@ -143,7 +142,7 @@ created from the correct base branch depending on the scope of the
changes: changes:
- ``master``: maintenance fixes, new features. Command: ``git fetch -p && git checkout --no-track -b MYBRANCH_NAME origin/master`` - ``master``: maintenance fixes, new features. Command: ``git fetch -p && git checkout --no-track -b MYBRANCH_NAME origin/master``
- ``release-vX.Y``: bugfixes. Command: ``git fetch -p && git checkout --no-track -b MYBRANCH_NAME origin/release-X.Y`` - ``release-next``: bugfixes. Command: ``git fetch -p && git checkout --no-track -b MYBRANCH_NAME origin/release-next``
Pull Requests Pull Requests
------------- -------------
......
...@@ -357,7 +357,7 @@ Update Branches For Jobs ...@@ -357,7 +357,7 @@ Update Branches For Jobs
import hudson.plugins.git.BranchSpec import hudson.plugins.git.BranchSpec
import static com.google.common.collect.Lists.newArrayList; import static com.google.common.collect.Lists.newArrayList;
def NEW_BRANCH = "*/release-v3.8" def NEW_BRANCH = "*/release-next"
// Access to the Hudson Singleton // Access to the Hudson Singleton
def jenkins = jenkins.model.Jenkins.instance; def jenkins = jenkins.model.Jenkins.instance;
......
...@@ -33,9 +33,9 @@ Authorisation ...@@ -33,9 +33,9 @@ Authorisation
Development Development
########### ###########
The patch release will be prepared based off the branch used to The patch release will be prepared based off the tag used to mark
construct to most recent major point release, e.g. ``release-v3.9`` the last minor release. A branch called ``release-next`` will be created from this tag.
would be used for any ``3.9.x`` patches. Changes for the patch should be made using the standard GitHub Changes for the patch should be made using the standard GitHub
workflow for merging code with ``master``. The issue and pull request should then have the ``PatchCandidate`` label applied to them. These workflow for merging code with ``master``. The issue and pull request should then have the ``PatchCandidate`` label applied to them. These
commits will then be cherry picked from ``master`` on to the release branch. commits will then be cherry picked from ``master`` on to the release branch.
...@@ -47,8 +47,7 @@ version of the last major/patch release. It is not a requirement but ...@@ -47,8 +47,7 @@ version of the last major/patch release. It is not a requirement but
advised to unfix the patch number while the patch is being compiled. advised to unfix the patch number while the patch is being compiled.
This prevents the nightly builds from generating a collection of packages that have This prevents the nightly builds from generating a collection of packages that have
exactly the same version. The patch number can be unfixed by commenting the line in exactly the same version. The patch number can be unfixed by commenting the line in
https://www.github.com/mantidproject/mantid/blob/release-vX.Y/buildconfig/CMake/VersionNumber.cmake#L9, where https://www.github.com/mantidproject/mantid/blob/release-next/buildconfig/CMake/VersionNumber.cmake#L9.
``X.Y`` should be replace with the appropriate numbers.
Release Notes Release Notes
------------- -------------
...@@ -107,11 +106,9 @@ On the day of release a few steps are required: ...@@ -107,11 +106,9 @@ On the day of release a few steps are required:
* update the patch version: * update the patch version:
* navigate to * navigate to
https://www.github.com/mantidproject/mantid/blob/release-X.Y./buildconfig/CMake/VersionNumber.cmake, https://www.github.com/mantidproject/mantid/blob/release-next/buildconfig/CMake/VersionNumber.cmake
where ``X`` & ``Y`` are the major and minor release versions
respectively.
* edit the ``VERSION_PATCH`` to the required number for the patch and * edit the ``VERSION_PATCH`` to the required number for the patch and
commit the result. commit the result
* run a manual build of all of the OS jobs under {{ * run a manual build of all of the OS jobs under {{
site.mantidreleasebuilds }} and when asked for a suffix use an empty site.mantidreleasebuilds }} and when asked for a suffix use an empty
string string
......
...@@ -137,10 +137,10 @@ Once the unscripted testing has passed: ...@@ -137,10 +137,10 @@ Once the unscripted testing has passed:
* Disable release deploy jobs by executing * Disable release deploy jobs by executing
`close-release-testing <http://builds.mantidproject.org/view/All/job/close-release-testing>`__ `close-release-testing <http://builds.mantidproject.org/view/All/job/close-release-testing>`__
job. job.
* On the ``release-vX.Y`` branch, update major & minor versions * On the ``release-next`` branch, update major & minor versions
accordingly in ``buildconfig/CMake/VersionNumber.cmake``. Also accordingly in ``buildconfig/CMake/VersionNumber.cmake``. Also
uncomment ``VERSION_PATCH`` and set it to ``0``. uncomment ``VERSION_PATCH`` and set it to ``0``.
* Merge ``release`` branch back to ``master`` * Merge ``release-next`` branch back to ``master``
* Comment out patch number on ``master`` branch * Comment out patch number on ``master`` branch
* Draft a `new * Draft a `new
release <https://github.com/mantidproject/mantid/releases>`__ on release <https://github.com/mantidproject/mantid/releases>`__ on
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment