From bd34bcb215c2636692a50884d50c7969a86182cb Mon Sep 17 00:00:00 2001 From: Kevin O'Gorman Date: Thu, 6 Aug 2020 18:34:37 -0700 Subject: [PATCH] Added instructions to update public documentation during a release --- docs/development/release_management.rst | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/docs/development/release_management.rst b/docs/development/release_management.rst index baebe3b7e3..f3436112d6 100644 --- a/docs/development/release_management.rst +++ b/docs/development/release_management.rst @@ -262,11 +262,20 @@ Release Process ``apt.freedom.press``. #. The reviewer must delete the ``release`` branch so that it can be re-created during the next release. -#. Issue a PR in the ``securedrop`` repository to merge the release branch - changes into ``stable``. Once the PR is merged, verify that the - `public documentation `_ - refers to the new release version. If not, log in to ReadTheDocs and start a - build of the ``stable`` version. +#. Update the `public documentation `_ by + synchronising the ``stable`` branch with the release branch: + + * If a repository maintainer is available, remove the branch protection on + the ``stable`` branch, hard-reset it to the release branch, and force push + ``stable``. Then restore branch protection on ``stable``. + + * If a maintainer is not available, create a PR with the release branch + changes using ``stable`` as the base. Version number updates will cause + conflicts which must be resolved manually before issuing the PR. + +#. Verify that the public documentation has been updated, by checking the + `ReadTheDocs build history `_. + If necessary, restart the build. #. Create a `release `_ on GitHub with a brief summary of the changes in this release.