Git trailers #355
Merged
Git trailers #355
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
contrib/hooks now contains a collection of git hooks that the developer can use to get faster feedback. contrib/hooks-setup is a script that allows the developer to do a quick set up of the provided hook. It is intended to be executed right after cloning the repo. The contrib/hooks/commit-msg hook checks the commit message to ensure that the git trailers in use are allowed, that is they are listed in contrib/allowed-trailers.txt.
We are going to enforce the use of git trailers, as we want to automate the construction of a changelog. See git-interpret-trailers(1). The check is achieved by running the contrib/hooks/commit-msg script on the individual commits that constitute the pull request.
Leveraging the git trailers, we have now a tool that builds the content of the NEWS file directly from the git history.
LDVG
approved these changes
Feb 28, 2025
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.
We are leveraging git trailers to automate the additions to the NEWS file during release.
Commits having the
Changelogtrailers are checked automatically, to enforce the use of a restricted set of values.The checks can be used as commit hooks during development. They're compatible by design.