vale-action: _onlyModified is failing

To report back: I just updated our workflow, and it seems to be working nicely. Notably, I changed from [push] to [pull_request], and now the workflow checks all files within a PR, not just the ones within one commit.

Here’s our config:

name: Vale
on: [pull_request]
jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - name: checkout
        uses: actions/checkout@master
      - name: vale
        uses: errata-ai/vale-action@master
        with:
          styles: |
            https://github.com/errata-ai/Microsoft/releases/latest/download/Microsoft.zip
            https://github.com/errata-ai/Google/releases/latest/download/Google.zip
            https://github.com/errata-ai/write-good/releases/latest/download/write-good.zip
          config: https://raw.githubusercontent.com/vaadin/docs/master/.vale.ini
          files: __onlyModified
        env:
          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

This should be fixed on @master now. Pending more testing, I’ll make a new release.

Getting a new release out is on my to-do list, but I don’t have a concrete timeline.

@jouni: I think that should be fixed now.

@jdkato at first sight that sounds very reasonable! I plan to have a deeper look at this after Jan 4 (in case the issue persists till then).

I got the same error as @jouni when using @master.

This works to check only modified files. It uses another action to grab only changed files and then vale checks that file. This works until _onlyModified is working.

name: Linting
on: [push]

jobs:
  prose:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout
      uses: actions/checkout@master
    - name: Get Changed Files
      id: get_changed_files
      uses: lots0logs/gh-action-get-changed-files@2.1.4
      with:
        token: ${{ secrets.GITHUB_TOKEN }}
    - name: Vale
      uses: errata-ai/vale-action@v1.3.0
      with:
        files: '${{ steps.get_changed_files.outputs.all }}'
      env:
        # Required
        GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

The most useful outcome would be for Vale to run against all changes in a PR, since the basis for approval of a PR is the set of all changes in the PR.

I tried using @master but got a slightly different error:

Error: Command failed with exit code 128: git diff --name-only undefined

I mentioned it here: https://github.com/errata-ai/vale-action/issues/22#issuecomment-726618738

These are unreleased features still, so you need to use the @master version (not @v1.3.0) to get access to them.

@pierrebeitz, thanks for the suggestion (and thanks for that contribution ).

We are using vale-action@master at the moment, with files: __onlyModified (but without onlyAnnotateModifiedLines), and it’s working alright. We just have a lot “debt” from before, so every PR gets a lot of noise from unmodified lines

I’m using this same configuration, and find that this setup encourages gradually solving existing issues in the files that are being changed. Since you already have some context about the information on that file, normally it’s not a big extra effort to review the identified issues (this may be different if you have very big files though).

@pierrebeitz, thanks for the suggestion (and thanks for that contribution 👍 ).

We are using vale-action@master at the moment, with files: __onlyModified (but without onlyAnnotateModifiedLines), and it’s working alright. We just have a lot “debt” from before, so every PR gets a lot of noise from unmodified lines 😅

What about onlyAnnotateModifiedLines, is that supposed to work already?

Hi, looking forward to using this flag. Any news on a fix? Thanks.

Just raising my hand to support adding onlyAnnotateModifiedLines to this great action. And thanks to @tjperry07 for the workaround!

It also returns an error for onlyAnnotateModifiedLines Warning: Unexpected input(s) 'onlyAnnotateModifiedLines', valid inputs are ['entryPoint', 'args', 'styles', 'config', 'files', 'debug']