Skip to content
bookmark

GitHub Action

misspell-fixer-action

0.1.0 Latest version

misspell-fixer-action

bookmark

misspell-fixer-action

Runs misspell-fixer as a Github Action

Installation

Copy and paste the following snippet into your .yml file.

              

- name: misspell-fixer-action

uses: sobolevn/[email protected]

Learn more about this action in sobolevn/misspell-fixer-action

Choose a version

misspell-fixer-action

wemake.services

📝Automatically fixes typos 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/[email protected]
  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.