Skip to content
📝Automatically fixes typos and mistakes in your source code and docs!
Shell Dockerfile
Use this GitHub Action with your project

Add this Action to an existing workflow or create a new one.

View on Marketplace
Branch: master
Clone or download

Latest commit

Latest commit d9009f6 Mar 20, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Initial import Mar 19, 2020
.gitignore
Dockerfile Initial import Mar 19, 2020
LICENSE Initial commit Mar 19, 2020
README.md Update README.md Mar 20, 2020
action.yml Finished the action itself Mar 19, 2020
entrypoint.sh Version 0.1.0 release Mar 19, 2020

README.md

misspell-fixer-action

wemake.services

📝Automatically fixes typos and mistakes in your source code and docs!

Based on awesome misspell-fixer tool.

Usage

We had a typo in our entrypoint.sh file to show how this Github Action works. By using a pipeline of three actions we are able to receive PRs like this one.

Here's how our configuration looks like:

- uses: actions/checkout@v2
- uses: sobolevn/misspell-fixer-action@master
- uses: peter-evans/create-pull-request@v2.4.4
  with:
    token: ${{ secrets.GITHUB_TOKEN }}

Here's how it works:

  1. The first actions/checkout@v2 action checkouts our code from the repo
  2. Our own sobolevn/misspell-fixer-action finds misspells and fixes them
  3. Then peter-evans/create-pull-request creates a PR with the fixes created earlier
  4. Done!

See logs of our own Github Actions with the fixed typo.

And here's how our workflow looks like.

Options and outputs

You can pass any options that are supported by misspell-fixer tool, to do so you can use options key:

- uses: sobolevn/misspell-fixer-action@master
  with:
    options: '-rsvn src/'

You can also use the output produced by this action by default. Read more about outputs.

License

MIT.

You can’t perform that action at this time.