Add check for non-inclusive language #310
Conversation
CHANGELOG.md
Outdated
|
|
||
| - Use GITHUB_REF_NAME as name of push branch; fix error in branch detection [citest skip] | ||
|
|
||
| We need to get the name of the branch to which CHANGELOG.md was pushed. | ||
| For now, it looks as though `GITHUB_REF_NAME` is that name. But don't | ||
| trust it - first, check that it is `main` or `master`. If not, then use | ||
| trust it - first, check that it is `main` or `master`. If not, then use // wokeignore:rule=master |
There was a problem hiding this comment.
ok - but I'd like to see what @Jakuje says about linux-system-roles/crypto_policies#54 (comment) - if the right answer is "just edit CHANGELOG.md to remove the problematic terms rather than put wokeignore in CHANGELOG.md" then this PR becomes much smaller and simpler i.e. can use the official woke instead of the custom
There was a problem hiding this comment.
Yeah, but this changelog item specifically refers to the master branch... How we could describe it without using the word master... In this case, I can just remove it, as it does not look that important(?), but there could be some cases that do not allow it???
There was a problem hiding this comment.
Yeah, but this changelog item specifically refers to the
masterbranch... How we could describe it without using the wordmaster... In this case, I can just remove it, as it does not look that important(?), but there could be some cases that do not allow it???
I think we can remove these entire entries from the changelog.
The problem with the auto-changelog generation that I wrote is
- it is pretty stupid - it just collects all of the git commit messages
- it requires a non-lazy human to edit - I should really have just summarized all of these changes as something like "fix github publish action" or something like that
Especially in this case - these can be replaced with - fix github action for publishing roles or similar
There was a problem hiding this comment.
Same below - just say - github action ansible test improvements
There was a problem hiding this comment.
Thanks, @richm! I'm updating CHANGELOG as you suggested.
|
Test was successful. Warning is not counted as an error. |
|
please remove/change the reference at https://github.com/linux-system-roles/logging/pull/310/files#diff-06572a96a58dc510037d5efa622f9bec8519bc1beab13c9f251e97e657a9d4edL448 also - then you can just use the standard woke action and don't have to use the custom action |
nhosoi
changed the title
|
[citest] |
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 Signed-off-by: Noriko Hosoi <[email protected]>
|
Thank you for your review, @richm. Merged. |
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
CHANGELOG.md - cleanup non-inclusive words.