sobolevn / misspell-fixer-action Goto Github PK

View Code? Open in Web Editor NEW

146.0 3.0 6.0 22 KB

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

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

License: MIT License

Dockerfile 42.05% Shell 57.95%

misspell misspell-fixer localization github-actions github-action github-action-localizstion

misspell-fixer-action's Introduction

misspell-fixer-action

📝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/[email protected]
  with:
    token: ${{ secrets.GITHUB_TOKEN }}

Here's how it works:

The first actions/checkout@v2 action checkouts our code from the repo
Our own sobolevn/misspell-fixer-action finds misspells and fixes them
Then peter-evans/create-pull-request creates a PR with the fixes created earlier
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.

misspell-fixer-action's People

Contributors

Stargazers

Watchers

Forkers

p4vook udokavrede jonsy13 jlevon olivierlefloch

misspell-fixer-action's Issues

Respect the '.misspell-fixer.ignore' file

Hiya @sobolevn
Awesome action - it is really useful, great work! :)

One problem that I am facing is that it doesn't seem to be using the .misspell-fixer.ignore, or maybe I have set it up incorrectly?

I basically just want to ignore my repos non-English translation files, so I created a .github/.misspell-fixer.ignore file, but it still submits PRs for those files. Is this because the ignore file is not supported by your action?

The `set-output` command is deprecated and will be disabled soon

Run gave:


misspell-fixer: Results of prefiltering: (filename:line:pattern)
misspell-fixer: Iteration 1: nothing to replace.
misspell-fixer: Iteration 1: done.
Warning: The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/

New release without deprecated `set-output` command

The set-output command is deprecated and will be disabled soon. See: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/

This seems to have been fixed in #12 and committed to master (also see #10 issue). Still the latest tagged version is v0.1.0, does not contains that fix and dates back to march 2020.

Is there any plan to tag a new release of misspell-fixer-action?

Log is expired at README.md

In the README.md we have a next phrase: "See logs of our own GitHub Actions with the fixed typo.", where link directs to GitHub action which shows that logs for this run have expired and are no longer available,

doesn't spot obvious spelling errors

sometimes the action omits obvious spelling errors leaving our users to spot and report them.
e.g. "urrent":

https://github.com/brainboxdotcc/DPP/pull/195/files

the configuration we are using is in the .github directory of the project under workflows.

any chance you can shed some light on it please?

action failure not detected

I'm running with options "." so the action should fail if there are mis-spellings. But the code is doing this:

# Fail the build in case status code is not 0:
if [ "$status" -ge 100 ]; then

I don't know why it's checking for 100 here, but the comment seems to imply what it should be doing.

Add to awesome-github actions

Error: Unable to process file command 'env' successfully.

Hello! 👋

using the following

name: Automatically fix typos
on:
  push:
    branches:
      - dev

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          ref: dev
      - uses: sobolevn/misspell-fixer-action@master
      - uses: peter-evans/[email protected]
        env:
          ACTIONS_ALLOW_UNSECURE_COMMANDS: 'true'
        with:
          token: ${{ secrets.GITHUB_TOKEN }}

returns the following error

Error: Unable to process file command 'env' successfully.
Error: Invalid format '+++ ./2019/index.html.68	2023-02-06 17:41:04.556125250 +0000'

I have been using this CI a lot and was working fine, but today returns error. I have tried a couple things but didn't work.

Full log here.

I also tried without the

env:
          ACTIONS_ALLOW_UNSECURE_COMMANDS: 'true'

but still returns error