[CDRIVER-5537] A Signed Release Archive + Augmented SBOM Publication #1637
Conversation
This file contains hidden or 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
- +release-archive generates an archive of the repository that contains the augmented SBOM downloaded from Silk - +sign-file can sign arbitrary files - +signed-release generates release artifacts using +release-archive and +sign-file to create a release archive and detached signature.
rcsanchez97
approved these changes
Jun 8, 2024
Earthfile
Outdated
|
|
||
| # sign-file : | ||
| # Sign an arbitrary file. This uses internal MongoDB tools and requires authentication | ||
| # to be used access them. (Refer to dev docs) |
There was a problem hiding this comment.
Suggested change
| # to be used access them. (Refer to dev docs) | |
| # to be used to access them. (Refer to dev docs) |
docs/dev/earthly.rst
Outdated
| .. option:: --branch <branch> | ||
|
|
||
| **Required**. Specifies the branch of the repository from which we are | ||
| requested an SBOM. |
There was a problem hiding this comment.
Should this be "are requesting" or "have requested"?
docs/dev/earthly.rst
Outdated
| .. option:: --file <filepath> | ||
|
|
||
| **Required**. Specify a path to a file (on the host) to be signed. This | ||
| file must be a descendent of the directory that contains the ``Earthfile`` |
There was a problem hiding this comment.
Suggested change
| file must be a descendent of the directory that contains the ``Earthfile`` | |
| file must be a descendant of the directory that contains the ``Earthfile`` |
kevinAlbs
requested changes
Jun 11, 2024
docs/dev/releasing.rst
Outdated
| the :any:`+signed-release` target. Let `$BRANCH` be the name of the Git branch | ||
| from which the release is being made:: | ||
|
|
||
| $ ./tools/earthly.sh --artifact +signed-release/dist dist --branch=$BRANCH --version=$NEW_VERSION |
There was a problem hiding this comment.
This may result in a tarball on a commit after the tag. The post_release_bump step before adds a commit to update VERSION_CURRENT.
Consider having the +signed-release target also do a git checkout to the NEW_VERSION to ensure the tarball is built with the correct VERSION_CURRENT file.
There was a problem hiding this comment.
I've modified the workflow to archive the tagged version rather than the branch revision, and renamed some of the parameters as appropriate.
kevinAlbs
approved these changes
Jun 11, 2024
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.
Summary
This changeset re-introduces a release archive process as part of the release process. This is significantly simplified from the old
makedistarchive, and is mostly just an archive produced by Git with some additional goodies, with more to be added in later changes.What's Included
Earthfileallows for far more comprehensive descriptions of what is possible.Other Notes