From baac0581623922c477a37d7716d0721bd85e8f7e Mon Sep 17 00:00:00 2001 From: Javier Vegas-Regidor Date: Tue, 9 Feb 2021 09:53:16 +0100 Subject: [PATCH] Change the order of the publication steps (#984) --- doc/contributing.rst | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/doc/contributing.rst b/doc/contributing.rst index a45b7fd030..09e881ea17 100644 --- a/doc/contributing.rst +++ b/doc/contributing.rst @@ -283,16 +283,26 @@ and the `GitHub Actions run `__. All tests should pass before making a release (branch). -2. Increase the version number +2. Create a release branch +~~~~~~~~~~~~~~~~~~~~~~~~~~ +Create a branch off the ``master`` branch and push it to GitHub. +Ask someone with administrative permissions to set up branch protection rules +for it so only you and the person helping you with the release can push to it. +Announce the name of the branch in an issue and ask the members of the +`ESMValTool development team `__ +to run their favourite recipe using this branch. + +3. Increase the version number ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The version number is stored in ``esmvalcore/_version.py``, ``package/meta.yaml``, ``CITATION.cff``. Make sure to update all files. Also update the release date in ``CITATION.cff``. See https://semver.org for more information on choosing a version number. -Make a pull request and get it merged into ``master``. +Make a pull request and get it merged into ``master`` and cherry pick it into +the release branch. -3. Add release notes +4. Add release notes ~~~~~~~~~~~~~~~~~~~~ Use the script `esmvaltool/utils/draft_release_notes.py `__ @@ -302,16 +312,8 @@ previous release. Review the results, and if anything needs changing, change it on GitHub and re-run the script until the changelog looks acceptable. Copy the result to the file ``doc/changelog.rst``. -Make a pull request and get it merged into ``master``. - -4. Create a release branch -~~~~~~~~~~~~~~~~~~~~~~~~~~ -Create a branch off the ``master`` branch and push it to GitHub. -Ask someone with administrative permissions to set up branch protection rules -for it so only you and the person helping you with the release can push to it. -Announce the name of the branch in an issue and ask the members of the -`ESMValTool development team `__ -to run their favourite recipe using this branch. +Make a pull request and get it merged into ``master`` and cherry pick it into +the release branch.. 5. Cherry pick bugfixes into the release branch ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~