ci: set up commit message conformance rules using ng-dev #20580
Merged
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
googlebot
added
the
cla: yes
josephperrott
force-pushed
the
commit-message-conformance
branch
2 times, most recently
from
85c4f2f to
c26871b
Compare
josephperrott
changed the title
josephperrott
force-pushed
the
commit-message-conformance
branch
from
c26871b to
1ffc8c6
Compare
josephperrott
force-pushed
the
commit-message-conformance
branch
from
1ffc8c6 to
32f57fa
Compare
josephperrott
added
the
target: patch
josephperrott
added
action: merge
wagnermaciel
pushed a commit
that referenced
this pull request
Sep 16, 2020
(cherry picked from commit 42be968)
|
@josephperrott Just came across this. Nice! Finally we can have consistent commit messages (and working changelog output then). I wonder if we should compose this list automatically in the future? With this change we now have multiple sources of truth for entry points (i.e. the corresponding |
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
With this change, commit messages are now checked as they are created locally, and then verified against CI upstream as well. Local commit message validation failures are treated as warnings, while on CI they are errors which are blocking.
On a bad commit message, you will see something like the following output:
If you would like commit message validation failures locally to to be treated as errors, failing to create a commit if the commit message validation failed, you can do so by setting a local config in your .ng-dev.user file (which is expected to be in a json format, or a js/ts file providing a default export object).
.ng-dev.user{ "commitMessage": { "errorOnInvalidMessage": true } }