Add an option "--count-only-error-for-failure" #252
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
Description: --count-only-error-for-failure Count only error items, not warning and info, for failure We have a requirement for a word not to cause a failure when the word has a rule whose severity is "warning" or "info".
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
👋 Thanks for submitting your first PR!
Please be sure to read and follow our Code of Conduct and Contributing guide.
⭐️ Is your org or open source project using woke? If so, we'd love for you to be included in the 'Who uses woke' list at https://github.com/get-woke/woke/blob/main/docs/about.md#who-uses-woke.
nhosoi
added a commit
to nhosoi/woke
that referenced
this pull request
Dec 13, 2022
For testing get-woke#252.
nhosoi
added a commit
to nhosoi/woke-action
that referenced
this pull request
Dec 13, 2022
nhosoi
added a commit
to nhosoi/woke-action
that referenced
this pull request
Dec 13, 2022
Use woke built from get-woke/woke#252.
nhosoi
added a commit
to nhosoi/logging
that referenced
this pull request
Dec 15, 2022
Add a check for usage of terms and language that is considered non-inclusive. We are using the woke tool for this with a wordlist that can be found at https://github.com/linux-system-roles/tox-lsr/blob/main/src/tox_lsr/config_files/woke.yml Note: this commit uses the customized woke placed locally in .github/actions/custom-woke-action. It will be replaced with the official woke once get-woke/woke#252 (Add an option "--count-only-error-for-failure") is processed. CHANGELOG.md - cleanup non-inclusive words.
nhosoi
added a commit
to nhosoi/certificate
that referenced
this pull request
Dec 15, 2022
Add a check for usage of terms and language that is considered non-inclusive. We are using the woke tool for this with a wordlist that can be found at https://github.com/linux-system-roles/tox-lsr/blob/main/src/tox_lsr/config_files/woke.yml Note: this commit uses the customized woke placed locally in .github/actions/custom-woke-action. It will be replaced with the official woke once get-woke/woke#252 (Add an option "--count-only-error-for-failure") is processed. CHANGELOG.md - cleanup non-inclusive words. tests/tasks/setup_ipa.yml - Apply "wokeignore:rule" Signed-off-by: Noriko Hosoi <nhosoi@redhat.com>
This was referenced Dec 15, 2022
nhosoi
added a commit
to nhosoi/mssql
that referenced
this pull request
Jan 5, 2023
Add a check for usage of terms and language that is considered non-inclusive. We are using the woke tool for this with a wordlist that can be found at https://github.com/linux-system-roles/tox-lsr/blob/main/src/tox_lsr/config_files/woke.yml Note: this commit uses the customized woke placed locally in .github/actions/custom-woke-action to support an new option --count-only-error-for-failure option. The local action custom-woke-action will be replaced with the official woke once get-woke/woke#252 (Add an option "--count-only-error-for-failure") is processed.
nhosoi
added a commit
to nhosoi/mssql
that referenced
this pull request
Jan 5, 2023
Add a check for usage of terms and language that is considered non-inclusive. We are using the woke tool for this with a wordlist that can be found at https://github.com/linux-system-roles/tox-lsr/blob/main/src/tox_lsr/config_files/woke.yml Note: this commit uses the customized woke placed locally in .github/actions/custom-woke-action to support an new option --count-only-error-for-failure option. The local action custom-woke-action will be replaced with the official woke once get-woke/woke#252 (Add an option "--count-only-error-for-failure") is processed.
nhosoi
added a commit
to nhosoi/mssql
that referenced
this pull request
Jan 5, 2023
Add a check for usage of terms and language that is considered non-inclusive. We are using the woke tool for this with a wordlist that can be found at https://github.com/linux-system-roles/tox-lsr/blob/main/src/tox_lsr/config_files/woke.yml Note: this commit uses the customized woke placed locally in .github/actions/custom-woke-action to support a new option --count-only-error-for-failure option. The local action custom-woke-action will be replaced with the official woke once get-woke/woke#252 (Add an option "--count-only-error-for-failure") is processed. Signed-off-by: Noriko Hosoi <nhosoi@redhat.com>
|
Dear woke developers / maintainers, Our project https://github.com/linux-system-roles/ is hoping to use this feature in the actions. Could you please take a look and share your thoughts? Thank you! |
|
Hi there! Apologies for the delay, my notifications for this repo didn't seem to be working. I will take a look and respond in the next few days. I appreciate your patience! |
Thanks for your response, @caitlinelfring! |
nhosoi
added a commit
to nhosoi/network
that referenced
this pull request
Jan 15, 2023
Add a check for usage of terms and language that is considered non-inclusive. We are using the woke tool for this with a wordlist that can be found at https://github.com/linux-system-roles/tox-lsr/blob/main/src/tox_lsr/config_files/woke.yml Note: this commit uses the customized woke placed locally in .github/actions/custom-woke-action to support a new option --count-only-error-for-failure option. The local action custom-woke-action will be replaced with the official woke once get-woke/woke#252 (Add an option "--count-only-error-for-failure") is processed. Signed-off-by: Noriko Hosoi <nhosoi@redhat.com>
nhosoi
added a commit
to nhosoi/ansible-pcp
that referenced
this pull request
Jan 16, 2023
Add a check for usage of terms and language that is considered non-inclusive. We are using the woke tool for this with a wordlist that can be found at https://github.com/linux-system-roles/tox-lsr/blob/main/src/tox_lsr/config_files/woke.yml Note: this commit uses the customized woke placed locally in .github/actions/custom-woke-action to support a new option --count-only-error-for-failure option. The local action custom-woke-action will be replaced with the official woke once get-woke/woke#252 (Add an option "--count-only-error-for-failure") is processed. Signed-off-by: Noriko Hosoi <nhosoi@redhat.com>
nhosoi
added a commit
to nhosoi/ansible-pcp
that referenced
this pull request
Jan 16, 2023
Add a check for usage of terms and language that is considered non-inclusive. We are using the woke tool for this with a wordlist that can be found at https://github.com/linux-system-roles/tox-lsr/blob/main/src/tox_lsr/config_files/woke.yml Note: this commit uses the customized woke placed locally in .github/actions/custom-woke-action to support a new option --count-only-error-for-failure option. The local action custom-woke-action will be replaced with the official woke once get-woke/woke#252 (Add an option "--count-only-error-for-failure") is processed. Signed-off-by: Noriko Hosoi <nhosoi@redhat.com>
nhosoi
added a commit
to nhosoi/network
that referenced
this pull request
Jan 16, 2023
Add a check for usage of terms and language that is considered non-inclusive. We are using the woke tool for this with a wordlist that can be found at https://github.com/linux-system-roles/tox-lsr/blob/main/src/tox_lsr/config_files/woke.yml Note: this commit uses the customized woke placed locally in .github/actions/custom-woke-action to support a new option --count-only-error-for-failure option. The local action custom-woke-action will be replaced with the official woke once get-woke/woke#252 (Add an option "--count-only-error-for-failure") is processed. Signed-off-by: Noriko Hosoi <nhosoi@redhat.com>
nhosoi
added a commit
to nhosoi/ssh
that referenced
this pull request
Jan 16, 2023
Add a check for usage of terms and language that is considered non-inclusive. We are using the woke tool for this with a wordlist that can be found at https://github.com/linux-system-roles/tox-lsr/blob/main/src/tox_lsr/config_files/woke.yml Note: this commit uses the customized woke placed locally in .github/actions/custom-woke-action to support a new option --count-only-error-for-failure option. The local action custom-woke-action will be replaced with the official woke once get-woke/woke#252 (Add an option "--count-only-error-for-failure") is processed. Signed-off-by: Noriko Hosoi <nhosoi@redhat.com>
nhosoi
added a commit
to nhosoi/ansible-pcp
that referenced
this pull request
Jan 17, 2023
Add a check for usage of terms and language that is considered non-inclusive. We are using the woke tool for this with a wordlist that can be found at https://github.com/linux-system-roles/tox-lsr/blob/main/src/tox_lsr/config_files/woke.yml Note: this commit uses the customized woke placed locally in .github/actions/custom-woke-action to support a new option --count-only-error-for-failure option. The local action custom-woke-action will be replaced with the official woke once get-woke/woke#252 (Add an option "--count-only-error-for-failure") is processed. Signed-off-by: Noriko Hosoi <nhosoi@redhat.com>
nhosoi
added a commit
to nhosoi/network
that referenced
this pull request
Jan 17, 2023
Add a check for usage of terms and language that is considered non-inclusive. We are using the woke tool for this with a wordlist that can be found at https://github.com/linux-system-roles/tox-lsr/blob/main/src/tox_lsr/config_files/woke.yml Note: this commit uses the customized woke placed locally in .github/actions/custom-woke-action to support a new option --count-only-error-for-failure option. The local action custom-woke-action will be replaced with the official woke once get-woke/woke#252 (Add an option "--count-only-error-for-failure") is processed. Signed-off-by: Noriko Hosoi <nhosoi@redhat.com>
richm
pushed a commit
to linux-system-roles/network
that referenced
this pull request
Jan 19, 2023
Add a check for usage of terms and language that is considered non-inclusive. We are using the woke tool for this with a wordlist that can be found at https://github.com/linux-system-roles/tox-lsr/blob/main/src/tox_lsr/config_files/woke.yml Note: this commit uses the customized woke placed locally in .github/actions/custom-woke-action to support a new option --count-only-error-for-failure option. The local action custom-woke-action will be replaced with the official woke once get-woke/woke#252 (Add an option "--count-only-error-for-failure") is processed. Signed-off-by: Noriko Hosoi <nhosoi@redhat.com>
spetrosi
pushed a commit
to linux-system-roles/mssql
that referenced
this pull request
Jan 25, 2023
* Cleanup non-inclusive words. - .collection/README.md - .collection/galaxy.yml - CHANGELOG.md * Add check for non-inclusive language Add a check for usage of terms and language that is considered non-inclusive. We are using the woke tool for this with a wordlist that can be found at https://github.com/linux-system-roles/tox-lsr/blob/main/src/tox_lsr/config_files/woke.yml Note: this commit uses the customized woke placed locally in .github/actions/custom-woke-action to support a new option --count-only-error-for-failure option. The local action custom-woke-action will be replaced with the official woke once get-woke/woke#252 (Add an option "--count-only-error-for-failure") is processed. Signed-off-by: Noriko Hosoi <nhosoi@redhat.com> Signed-off-by: Noriko Hosoi <nhosoi@redhat.com>
|
Hello @caitlinelfring, is there any update on this PR? |
2 similar comments
|
Hello @caitlinelfring, is there any update on this PR? |
|
Hello @caitlinelfring, is there any update on this PR? |
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.
Description:
--count-only-error-for-failure
Count only error items, not warning and info, for failure
We have a requirement for a word not to cause a failure when the word has a rule whose severity is
warningorinfo.Note
As long as the requirement is satisfied, we do not mind how it'd be implemented. So, if my proposal does not fit in the current design, please feel free to close this PR in favor of a better one. Thanks in advance!
Please check if the PR fulfills these requirements
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
This PR adds an option
--count-only-error-for-failure. When this option is given along with--exit-1-on-failure, even if a word whose rule specifies the warning level of severity (or info) is found, it does not exit as a failure.What is the current behavior? (You can also link to an open issue here)
Regardless of the severity level, any finding makes
wokeexit with 1 if--exit-1-on-failureis specified.If you are interested in, this is the PR in which I ran into the issue.
linux-system-roles/logging#307 (comment)
What is the new behavior (if this is a feature change)?
If
--count-only-error-for-failureis specified along with--exit-1-on-failure, findings whose rule has the warning or info level of the severity will not causewokeexit with 1.Does this PR introduce a breaking change? (What changes might users need to make due to this PR?)
Unless
--count-only-error-for-failureis specified, there are no behavioral changes.