Git Product home page Git Product logo

vale-action's Introduction

simbo/vale-action

A GitHub action to run Vale for spell-checking with optional Reviewdog integration.

It does pretty much the same like the official Vale action, but as this one is not using Docker, it's much faster.

Usage

Use simbo/vale-action@v1 in your GitHub action workflow.

Your project should have a vale.ini.

Example

jobs:
  notify:
    runs-on: ubuntu-latest
    steps:
      - name: ๐Ÿ›Ž Checkout
        uses: actions/checkout@v3

      - name: ๐Ÿง‘โ€๐Ÿซ Spell-Check
        env:
          GITHUB_TOKEN: ${{ github.token }}
        uses: simbo/vale-action@v1

Inputs

Input Required Default Description
version no (latest) Vale release version to use.
flags no '' Space-delimited list of flags for the Vale CLI. To see a full list of available flags, run vale -h.
files no '.' Space-delimited list of file or directory arguments; equivalent to calling vale input1 input2.
reviewdog no 'false' Whether to use Vale with Reviewdog.
github_token no '${{ github.token }}' The GitHub repo access token to be used for Reviewdog.
github_com_pat no โ€“ A GitHub.com PAT to avoid API rate limits
reporter no 'github-pr-review' Set the reporter type for Reviewdog.
fail_on_error no 'false' By default, Reviewdog will return exit code 0 even if it finds errors. If fail_on_error is enabled, Reviewdog exits with 1 when at least one error was reported.
filter_mode no 'added' Set the filter mode for Reviewdog.

Outputs

This action has no outputs. ๐Ÿคทโ€โ™‚๏ธ

Development

Creating a new Version

Use ./release.sh <major|minor|patch> which will create a git tag for the respective version.

A release workflow will pick up the tag when pushed to GitHub, create a release and move major, minor and latest tags accordingly.

To publish the release into the GitHub marketplace open releases and update the release for marketplace publishing.

License

MIT ยฉ Simon Lepel

vale-action's People

Contributors

simbo avatar

Stargazers

 avatar

Watchers

 avatar  avatar

vale-action's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.