feat: add support for cutting-lines and footers with blank lines #274
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
github-actions
bot
added
bump:minor
KevinDeJong-TomTom
force-pushed
the
chore/eslint-configuration
branch
from
98b7835
to
67937cc
Compare
KevinDeJong-TomTom
changed the title
jstmlr
reviewed
Dec 7, 2023
maikelvdh
reviewed
Dec 7, 2023
maikelvdh
reviewed
Dec 7, 2023
maikelvdh
reviewed
Dec 7, 2023
maikelvdh
approved these changes
Dec 7, 2023
KevinDeJong-TomTom
force-pushed
the
chore/eslint-configuration
branch
from
67937cc
to
684a4e6
Compare
In addition, the configuration has been migrated from `.JSON` to `.XML`, as is the now recommended layout by ESLint
Originally we would catch all exceptions thrown in the validate, bump, and CLI execution. As a result, the action will ignore certain failures and, in case of `bump`, continue as if nothing went wrong (but also without the associated bump).
This commit introduces support for cutting-lines, as inserted
by GitHub in certain merge strategies. In example:
```
feat: remove logout button
BREAKING-CHANGE: this removes the logout button as we want
all users to be trapped in this application
--------
co-authored-by: Bob the Builder
```
This would originally result in only the `co-authored-by` trailer
to be accepted, dropping the `BREAKING CHANGE` flag (and therefor
only bumping the MINOR version).
This change will ignore the cutting-line and consider both elements
in the above example as valid trailers.
NOTE: the cutting-line is the only exception, any other paragraph
entry will still discard previous git-trailers; i.e.
```
feat: remove logout button
BREAKING-CHANGE: this removes the logout button as we want
all users to be trapped in this application
--------
This parapgraph causes the BREAKING-CHANGE to be discarded
co-authored-by: Bob the Builder
```
KevinDeJong-TomTom
force-pushed
the
chore/eslint-configuration
branch
from
f33beb2
to
ca4282c
Compare
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.
This PR introduces a few features and improvements, incl:
Ensure that unexpected exceptions are no longer caught
Originally we would catch all exceptions thrown in the validate,
bump, and CLI execution. As a result, the action will ignore certain
failures and, in case of
bump, continue as if nothing went wrong(but also without the associated bump).
Support for cutting-lines
Cutting lines (
--------), as inserted by GitHub in certain merge strategies, would be considered as a paragraph.In example:
This would originally result in only the
co-authored-bytrailerto be accepted, dropping the
BREAKING CHANGEflag (and thereforonly bumping the MINOR version).
This change will ignore the cutting-line and consider both elements
in the above example as valid trailers.
NOTE: the cutting-line is the only exception, any other paragraph
entry will still discard previous git-trailers; i.e.
Add --verbose option to the CLI to pretty print commits
Running the
checkcommand with the--verbose-flag will provide more details about the commit message: