Mention the regex sensitivity of commit_filter strings
#385
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
Polished the README to note that the `commit_filter` option is
sensitive to regex characters. This was not immediately obvious and can
cause a bit of confusion. Even leading to suspecting a defect in the
implementation of the filter as it can send the resource into a whacky
state of not selecting any commits (since the filter expression would
then be malformed).
Updated the README to mention this, and give an example of configuring
the `commit_filter.exclude` with a bracketed string that escapes the
bracket characters.
commit_filter:
exclude: ["\\[skip deploy\\]", "\\[deploy skip\\]"]
Lastly, also fixed a typo and removed the fully qualified dot notation
when describing the sub-elements of `commit_filter` in the README.
was:
commit_filter:
commit_filter.exclude:
commit_filter_include:
now:
commit_filter:
exclude:
include:
This aligns with the convention used in all other configuration options.
Only the README was changed in this commit.
Signed-off-by: Justin Griffin <[email protected]>
xtremerui
approved these changes
Jun 6, 2022
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.
Polished the README to note that the
commit_filteroption issensitive to regex characters. This was not immediately obvious and can
cause a bit of confusion. Even leading to suspecting a defect in the
implementation of the filter as it can send the resource into a whacky
state of not selecting any commits (since the filter expression would
then be malformed).
Updated the README to mention this, and give an example of configuring
the
commit_filter.excludewith a bracketed string that escapes thebracket characters.
Lastly, also fixed a typo and removed the fully qualified dot notation
when describing the sub-elements of
commit_filterin the README.was:
now:
This aligns with the convention used in all other configuration options.
Only the README was changed in this commit.