diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index b932375f..b79a2c10 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -27,6 +27,13 @@ jobs: - name: Run Vale uses: errata-ai/vale-action@reviewdog + with: + debug: true + # github-pr-check, github-pr-review, github-check + reporter: github-pr-check + # added, diff_context, file, nofilter + filter_mode: nofilter + vale_flags: "--glob='*.{txt,md}'" env: # Required, set by GitHub actions automatically: # https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret diff --git a/.github/workflows/vale.yml b/.github/workflows/vale.yml new file mode 100644 index 00000000..6430a07f --- /dev/null +++ b/.github/workflows/vale.yml @@ -0,0 +1,40 @@ +# This is a basic workflow to help you get started with Actions + +name: Vale-Container + +# Controls when the workflow will run +on: + # Triggers the workflow on push or pull request events but only for the "main" branch + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# A workflow run is made up of one or more jobs that can run sequentially or in parallel +jobs: + # This workflow contains a single job called "build" + vale-container: + # The type of runner that the job will run on + runs-on: ubuntu-latest + container: + image: jdkato/vale + volumes: + - styles:/styles + - docs:/docs + options: --cpus 1 + # Steps represent a sequence of tasks that will be executed as part of the job + steps: + # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it + - uses: actions/checkout@v3 + + - name: Run Vale + run: | + vale sync + vale --glob='*.{txt,md}' . + env: + # Required, set by GitHub actions automatically: + # https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 00000000..0922530c --- /dev/null +++ b/.vale.ini @@ -0,0 +1,9 @@ +StylesPath = styles + +MinAlertLevel = suggestion +Vocab = Base + +Packages = Google, proselint, write-good, alex, Readability, Joblint + +[*] +BasedOnStyles = Vale, Google, proselint, write-good, alex, Readability, Joblint