WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Commit 6bea4f7

Browse files
committed
v2.0.0 release
Signed-off-by: JJ Asghar <[email protected]>
1 parent bc661da commit 6bea4f7

File tree

3 files changed

+11
-16
lines changed

3 files changed

+11
-16
lines changed

README.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,14 @@ There's only one script in the repo. It replaces problematic words in a code bas
55
## Scope
66

77
This is a simple docker container that walks through a directory and changes any
8-
instance of `Master` to `Leader`. As a bonus, it also does the same thing with
9-
`Slave` to `Follower`.
8+
instance of some problematic words to something more socially acceptable, for instance:
9+
`slave` to `follower` or `master` to `leader`. You can look at the `dict` we created
10+
[here][here] are more then willing to accept PRs to add to them.
1011

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

14-
### Run in a container
15+
### Run in a container (aka locally)
1516

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

@@ -43,8 +44,8 @@ The script is also available as a [GitHub Action](action.yml). See this [repo](h
4344
steps:
4445
- name: Checking out our code
4546
uses: actions/checkout@master
46-
- name: Remove the images
47-
uses: jjasghar/actions-words-really-matter@v1.0.1
47+
- name: Remove the problematic words
48+
uses: jjasghar/actions-words-really-matter@v2.0.0
4849
- name: Create Pull Request
4950
uses: peter-evans/create-pull-request@v2
5051
with:
@@ -61,14 +62,6 @@ The script is also available as a [GitHub Action](action.yml). See this [repo](h
6162
echo "Pull Request Number - ${{ steps.cpr.outputs.pr_number }}"
6263
```
6364
64-
### Run locally
65-
66-
Just clone the repo, or copy and paste the code, and run it.
67-
68-
```bash
69-
./entrypoint.sh
70-
```
71-
7265
## Tips
7366
7467
If you want to re-build this with debug logs, just add this line to the `Dockerfile`:
@@ -101,3 +94,5 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10194
See the License for the specific language governing permissions and
10295
limitations under the License.
10396
```
97+
98+
[here]: https://github.com/jjasghar/actions-words-really-matter/blob/master/entrypoint.sh#L22-L24

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: 'Words Matter'
1+
name: 'Words Really Matter'
22
description: 'Change problematic words'
33
branding:
44
icon: 'book-open'

test/test.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Some header
22

3-
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.
3+
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.
44

5-
The same can be said for blacklist and whitelist.
5+
The same can be said for denylist and allowlist.
66

77
For good measure replace GRANDFATHERED and GUYS too.

0 commit comments

Comments
 (0)