├── .github └── workflows │ └── lang-linter.yml ├── Dockerfile ├── README.md ├── action.yml └── entrypoint.sh /.github/workflows/lang-linter.yml: -------------------------------------------------------------------------------- 1 | name: Language Linting 2 | on: [push, pull_request] 3 | 4 | jobs: 5 | alex-linting: 6 | runs-on: ubuntu-latest 7 | steps: 8 | - uses: actions/checkout@master 9 | - name: alex 10 | uses: theashraf/alex-action@master 11 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM node:12-alpine 2 | 3 | COPY entrypoint.sh /entrypoint.sh 4 | 5 | ENTRYPOINT ["/entrypoint.sh"] -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Alex Github Action 2 | 3 | > GitHub Action to automate catching insensitive ,inconsiderate writing. 4 | 5 | ## What 6 | 7 | GitHub Action for [alex](https://alexjs.com/). 8 | 9 | alex helps you find gender favouring, polarising, race related, religion inconsiderate, or other unequal phrasing in text. 10 | 11 | ## Why 12 | 13 | - Helps to get better at considerate writing 14 | - Catches many possible offences 15 | - Suggests helpful alternatives 16 | 17 | ## Usage 18 | 19 | On your GitHub Actions workflow file, add the following step: 20 | 21 | ```yaml 22 | steps: 23 | uses: theashraf/alex-action@master 24 | ``` 25 | 26 | This will run the "alex ." command without arguments. 27 | -------------------------------------------------------------------------------- /action.yml: -------------------------------------------------------------------------------- 1 | name: "alex" 2 | description: "Catch insensitive, inconsiderate writing" 3 | runs: 4 | using: "docker" 5 | image: "Dockerfile" 6 | -------------------------------------------------------------------------------- /entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh -l 2 | 3 | npx alex --------------------------------------------------------------------------------