Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document tag-naming convention for components in sd-builder repo #71

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document tag-naming convention for components in sd-builder repo #71

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/workstation_release_management.rst
View file
Open in desktop
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``),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the very pedantic suggestion:

Suggested change
``securedrop-<component>-<major>.<minor>.<patch>-rcN``; for components outside this repo (i.e. ``securedrop-client``),
``securedrop-<component>-<major>.<minor>.<patch>-rcN``; for components outside this repo (e.g. ``securedrop-client``),

As an aside, I always considered the component name to be e.g. "securedrop-keyring", not "keyring". But writing it this way make it very clear that the "securedrop-" prefix should be included 👍🏾

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