Skip to content

Commit

Permalink
v2.0.0 release
Browse files Browse the repository at this point in the history
Signed-off-by: JJ Asghar <jjasghar@gmail.com>
  • Loading branch information
jjasghar committed Oct 15, 2020
1 parent bc661da commit 6bea4f7
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 16 deletions.
21 changes: 8 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,14 @@ There's only one script in the repo. It replaces problematic words in a code bas
## Scope

This is a simple docker container that walks through a directory and changes any
instance of `Master` to `Leader`. As a bonus, it also does the same thing with
`Slave` to `Follower`.
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][here] are more then willing to accept PRs to add to them.

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
### Run in a container (aka locally)

There is a [containerized version](Dockerfile) of the script Run these commands from your project root:

Expand Down Expand Up @@ -43,8 +44,8 @@ The script is also available as a [GitHub Action](action.yml). See this [repo](h
steps:
- name: Checking out our code
uses: actions/checkout@master
- name: Remove the images
uses: jjasghar/actions-words-really-matter@v1.0.1
- name: Remove the problematic words
uses: jjasghar/actions-words-really-matter@v2.0.0
- name: Create Pull Request
uses: peter-evans/create-pull-request@v2
with:
Expand All @@ -61,14 +62,6 @@ The script is also available as a [GitHub Action](action.yml). See this [repo](h
echo "Pull Request Number - ${{ steps.cpr.outputs.pr_number }}"
```
### Run locally
Just clone the repo, or copy and paste the code, and run it.
```bash
./entrypoint.sh
```

## Tips
If you want to re-build this with debug logs, just add this line to the `Dockerfile`:
Expand Down Expand Up @@ -101,3 +94,5 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```

[here]: https://github.com/jjasghar/actions-words-really-matter/blob/master/entrypoint.sh#L22-L24
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: 'Words Matter'
name: 'Words Really Matter'
description: 'Change problematic words'
branding:
icon: 'book-open'
Expand Down
4 changes: 2 additions & 2 deletions test/test.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Some header

Master and slave are problematic words that don't need to be used in technical documentation when there are alternatives that serve the same purpose.
Master and follower are problematic words that don't need to be used in technical documentation when there are alternatives that serve the same purpose.

The same can be said for blacklist and whitelist.
The same can be said for denylist and allowlist.

For good measure replace GRANDFATHERED and GUYS too.

0 comments on commit 6bea4f7

Please sign in to comment.