Skip to content

Commit

Permalink
Document tag-naming convention for components in sd-builder repo.
Browse files Browse the repository at this point in the history
  • Loading branch information
rocodes committed May 30, 2023
1 parent fdfc497 commit a4f385d
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions docs/workstation_release_management.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,9 @@ Step 1: Create a release candidate (rc) tag

1. Create a release branch in the repo of the component you want to release.
2. Push a changelog commit.
3. Push an rc tag in the format ``<major>.<minor>.<patch>~rcN`` on your new commit. We will be building from this tag in the next step.
3. Push an rc tag on your new commit. For components in the ``securedrop-builder`` repo, use the tag format
``securedrop-<component>-<major>.<minor>.<patch>-rcN``; for components outside this repo (i.e. ``securedrop-client``),
use the tag format ``<major>.<minor>.<patch>-rcN``. We will be building from this tag in the next step.

Step 2: Build and deploy the package to ``apt-test``
----------------------------------------------------
Expand Down Expand Up @@ -78,7 +80,8 @@ Step 4: Create a release tag

Begin this step on the day you want to release the package. It's best to start this process early in the day to ensure there is enough time for final QA checks, signing ceremonies, and stakeholder communications.

1. Push a release tag on the same commit of the rc tag that was approved during QA.
1. Push a release tag on the same commit of the rc tag that was approved during QA. Follow the tag-naming convention as described
above.
2. :ref:`Sign the tag with the SecureDrop release key` (or ask another maintainer to do this).

Step 5: Build and deploy the package to ``apt-qa``
Expand Down

0 comments on commit a4f385d

Please sign in to comment.