sobolevn / misspell-fixer-action

đź“ťAutomatically fixes typos and mistakes in your source code and docs!

Home Page:https://github.com/marketplace/actions/misspell-fixer-action

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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!

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.

About

đź“ťAutomatically fixes typos and mistakes in your source code and docs!

https://github.com/marketplace/actions/misspell-fixer-action

License:MIT License


Languages

Language:Shell 57.9%Language:Dockerfile 42.1%