words-really-matter

There's only one script in the repo. It replaces problematic words in a code base. It specifically looks at markdown files only. There are multiple ways to run this script.

Scope

This is a simple docker container that walks through a directory and changes any instance of some problematic words to something more socially acceptable, for instance: slave to follower or master to leader. You can look at the dict we created here and are more than willing to accept PRs to add to the list.

The idea is that this can create a PR for repos via GitHub Actions so we as developers can have bots make sure we start to take these words out of our vocabulary.

Run in a container (aka locally)

There is a containerized version of the script Run these commands from your project root:

docker build -t words-matter .
cd <to source code>
docker run -v `pwd`:/source words-matter

You can of course take the script itself and run it locally, just be aware that you need use bash 4.0 or later and you'll have to push your own changes.

Run as a GitHub Action

The script can also be run as a GitHub Action and is available in the GitHub Action Marketplace.

For an example run check out this sample output and the corresponding pull request is generated.

To use this function in your repository perform the following steps:

1. Create a GitHub Secret with the key name GH_TOKEN and it's value be a GitHub API key.

2. Create a file in .github/workflows/ and paste the following code:

   on:
     push:
       branches:
         - main
         - master
   
   jobs:
     words-matter:
       runs-on: ubuntu-latest
       name: A job to remove problematic words
       steps:
         - name: Checking out our code
           uses: actions/checkout@master
         - name: Remove the problematic words
           uses: jjasghar/[email protected]
         - name: Create Pull Request
           id: cpr
           uses: peter-evans/create-pull-request@v3
           with:
             token: ${{ secrets.GH_TOKEN }}
             commit-message: Remove problematic words
             title: '[Automated PR] Remove problematic words'
             body: |
               Found a problematic words that can be replaced
   
               [1]: https://github.com/jjasghar/actions-words-really-matter
         - name: Check outputs
           run: |
             echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
             echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}"

Override or add to the dictionary

If you want to override some of our values or just add your own then pass them as environment variables that start with WORDS_. For example, add this block to your GitHub Action workflow

   env:
     WORDS_foo: bar

Tips

Debug

If you want to re-build this with debug logs, just add this line to the Dockerfile:

ENV DEBUG=true

Re-build it locally and run it.

pre-commit hook

If you can't run GitHub Actions and would still like to run this locally with thinking about it, you can use the pre-commit hook in this repository. Just place this file in .git/hooks in the repo you want to test and every time you used git commit it'll run. If it finds words to change, it'll change them for you, but NOT stage the differences.

License & Authors

If you would like to see the detailed LICENSE click here.

• Author: JJ Asghar [email protected]
• Author: Steve Martinelli [email protected]