Doc: Trusted Checksums Summary File Procedure#1886
Open
adambkaplan wants to merge 1 commit into
Open
Conversation
Document the procedure to save Trusted Checksum summary files to
version control. This procedure utilizes the `.mvn/config` file for
consistent invocation and the `${session.rootDirectory}` variable,
which is only available in Maven 3.9.x. The configuration was taken
from an example "locked down" repository provided by @cstamas. [1]
Unfortunately, saving Trusted Checksum summary files to version control
can cause dependency management tools like Renovate and GitHub
Dependabot to break builds. It is my hope that with improved
documentation, the dependency management tool ecosystem will be able to
appropriately update these trusted checksum files if present.
[1] https://github.com/ipfs-shipyard/java-ipfs-http-client
Signed-off-by: Adam Kaplan <adam@adambkaplan.com>
adambkaplan
force-pushed
the
trusted-checksums-procedure
branch
from
b6043d3 to
aadfd0c
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Document the procedure to save Trusted Checksum summary files to version control. This procedure utilizes the
.mvn/configfile for consistent invocation and the${session.rootDirectory}variable, which is only available in Maven 3.9.x. The configuration was taken from an example "locked down" repository provided by @cstamas. [1]Unfortunately, saving Trusted Checksum summary files to version control can cause dependency management tools like Renovate and GitHub Dependabot to break builds. It is my hope that with improved documentation, the dependency management tool ecosystem will be able to appropriately update these trusted checksum files if present.
[1] https://github.com/ipfs-shipyard/java-ipfs-http-client
Following this checklist to help us incorporate your
contribution quickly and easily:
Note that commits might be squashed by a maintainer on merge.
This may not always be possible but is a best-practice.
mvn verifyto make sure basic checks pass.A more thorough check will be performed on your pull request automatically.
mvn -Prun-its verify).If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.
To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.