Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Mention the regex sensitivity of commit_filter strings #385

Merged
merged 1 commit into from
Jun 6, 2022
Merged

Mention the regex sensitivity of commit_filter strings #385

merged 1 commit into from
Jun 6, 2022

Commits on Jun 3, 2022

  1. Mention the regex sensitivity of commit_filter strings 

    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 <justin.griffin@ngc.com>
    Justin Griffin committed Jun 3, 2022
    Configuration menu
    Copy the full SHA
    5e613de View commit details
    Browse the repository at this point in the history