linux-system-roles / certificate

Role for managing TLS/SSL certificate issuance and renewal
https://linux-system-roles.github.io/certificate/
MIT License
30 stars 21 forks source link

Add check for non-inclusive language #142

Closed nhosoi closed 1 year ago

nhosoi commented 1 year ago

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"

nhosoi commented 1 year ago

Note: If https://github.com/linux-system-roles/certificate/pull/142/commits/38a2f3abb9deb9a2bccc1be56591505e567c58e1 is acceptable, we can use the action woke-action with the released woke.

nhosoi commented 1 year ago

[citest]

nhosoi commented 1 year ago

[citest]

richm commented 1 year ago

So if you omit the version: master from the setup_ipa, and edit the CHANGELOG.md to remove references to sanity, can you use the official woke github action instead of the custom one?

nhosoi commented 1 year ago

So if you omit the version: master from the setup_ipa, and edit the CHANGELOG.md to remove references to sanity, can you use the official woke github action instead of the custom one?

Yes, we can. Do we want to avoid using ansible-test sanity? Just say ansible-test?

richm commented 1 year ago

So if you omit the version: master from the setup_ipa, and edit the CHANGELOG.md to remove references to sanity, can you use the official woke github action instead of the custom one?

Yes, we can. Do we want to avoid using ansible-test sanity? Just say ansible-test?

Yes, just say ansible-test

nhosoi commented 1 year ago

[citest]

rafasgj commented 1 year ago

About the 'version: master' on ansible-freeipa checkout, since I lost the argument to change it to "main", as we use it only to deploy IPA, and there won't be many changes, specially on what we need, we could pin the version to 'v1.9.0", and avoid the use of "master".

nhosoi commented 1 year ago

@richm, @rafasgj, @spetrosi, could you please review this pr one more time? Thanks!

richm commented 1 year ago

@nhosoi, although I don't understand why we can't pin the ansible freeipa version (and then don't have the # noqa comment, this change looks good to me.

My only concern is that it stays on an old version for a long time and never gets updated, which is what has happened in the past: https://github.com/linux-system-roles/certificate/commit/e84385a369969af5bdb64481934f6abb3204012a https://github.com/linux-system-roles/certificate/commit/cc7d5a953bce80151c037decbf952e3993d56721#diff-d1ca26ec3f441ccd0c4bb18b601d19668a8ffacfab0c71694fea7b46adc9823cL15

So if we have some (preferably automated) process for regularly updating the version, that's fine with me.

And the use of woke looks promising, specially for the future. Thank you for looking into this issue!

I'm approving these changes.

nhosoi commented 1 year ago

My only concern is that it stays on an old version for a long time and never gets updated, which is what has happened in the past: e84385a cc7d5a9#diff-d1ca26ec3f441ccd0c4bb18b601d19668a8ffacfab0c71694fea7b46adc9823cL15

So if we have some (preferably automated) process for regularly updating the version, that's fine with me.

Me, too. @rjeffman, do you want me to revert the version: master line? Or any specific version in your mind? And maybe, we'd like to have a tiny github action to check the ansible-freeipa version?

rjeffman commented 1 year ago

Me, too. @rjeffman, do you want me to revert the version: master line? Or any specific version in your mind? And maybe, we'd like to have a tiny github action to check the ansible-freeipa version?

Hmm... I have bug to fix where an external dependency is broken. Maybe we could have a Github action that setup all the testing dependencies.

But that's for the future, I'm fine with this PR as it is.

richm commented 1 year ago

[citest]