errata-ai / vale-action

:octocat: The official GitHub Action for Vale -- install, manage, and run Vale with ease.
MIT License
201 stars 51 forks source link

v2.0.0 re-write #65

Closed jdkato closed 2 years ago

jdkato commented 2 years ago

With the release of v2.16.0 of Vale, the CLI now has built-in (and improved) support for the action's config-handling features.

There's also been a number of changes to GitHub Actions since this one was created, so I figure it's a good time to think about a re-write:

maybe more ...

glebbash commented 2 years ago

@jdkato maybe it is also better to switch to vale 2.16 before the rewrite? So that packages will be available in vale-action a bit faster.

jdkato commented 2 years ago

It's already pretty close to being ready to use. Check out the reviewdog branch.

glebbash commented 2 years ago

New action works great 😍. Fulfills all our needs.

Thanks for improving this great tool! 🤝

JulioPDX commented 2 years ago

Testing this version has worked fantastic. One question, is there a way for vale to run on all md files in the repo vs just the ones that have been submitted with a PR? Good for repos that already exist with documentation vs new files in PR. Thank you

jdkato commented 2 years ago

You should be able to use a combination of github-check and nofilter.

lint:
    name: runner / vale
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: errata-ai/vale-action@reviewdog
        with:
          # only needed if you want push events too
          reporter: github-check
          filter_mode: nofilter
        env:
          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
JulioPDX commented 2 years ago

You should be able to use a combination of github-check and nofilter.

lint:
    name: runner / vale
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: errata-ai/vale-action@reviewdog
        with:
          # only needed if you want push events too
          reporter: github-check
          filter_mode: nofilter
        env:
          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

I will give this a try. Thank you @jdkato ☺️

paddyroddy commented 2 years ago

You should be able to use a combination of github-check and nofilter.

lint:
    name: runner / vale
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: errata-ai/vale-action@reviewdog
        with:
          # only needed if you want push events too
          reporter: github-check
          filter: nofilter
        env:
          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

You mean filter_mode not filter though, right?

jdkato commented 2 years ago

Yep, updated.

Namyalg commented 2 years ago

@jdkato , this workflow run doesn't fail on the occurrence of errors. Is there any additional configuration needed ? action.yml : https://github.com/Namyalg/vale-boilerplate/blob/master/.github/workflows/action.yml .vale.ini : https://github.com/Namyalg/vale-boilerplate/blob/master/.vale.ini

jdkato commented 2 years ago

@Namyalg, you need to add reporter: github-check if you want it to fail for push events too.

Namyalg commented 2 years ago

Thank you, it works as expected now.