Document tag-naming convention for components in sd-builder repo #71
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
rocodes
commented
May 30, 2023
rocodes
commented
- Refs Use per-component tags instead of one overall repository tag securedrop-builder#448
- Also changed the tag format to remove the tilde and include a dash, since git does not accept tildes in tags
rocodes
force-pushed
the
component-tags-in-sd-builder
branch
from
1f0b5de to
a4f385d
Compare
legoktm
reviewed
May 30, 2023
| @@ -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``), | |||
There was a problem hiding this comment.
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 👍🏾
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.