-
Notifications
You must be signed in to change notification settings - Fork 61
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.
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
Add an option "--count-only-error-for-failure" #252
base: main
Are you sure you want to change the base?
Conversation
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".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👋 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.
For testing get-woke#252.
Use woke built from get-woke/woke#252.
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.
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 <[email protected]>
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.
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.
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 <[email protected]>
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! |
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 <[email protected]>
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 <[email protected]>
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 <[email protected]>
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 <[email protected]>
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 <[email protected]>
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 <[email protected]>
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 <[email protected]>
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 <[email protected]>
* 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 <[email protected]> Signed-off-by: Noriko Hosoi <[email protected]>
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? |
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
orinfo
.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
woke
exit with 1 if--exit-1-on-failure
is 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-failure
is specified along with--exit-1-on-failure
, findings whose rule has the warning or info level of the severity will not causewoke
exit 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-failure
is specified, there are no behavioral changes.