vale-action icon indicating copy to clipboard operation
vale-action copied to clipboard

Conclusion is success despite ERROR

Open pwalleni opened this issue 2 years ago • 2 comments

Hi! Given the following settings in .vale.ini:

Packages = Microsoft

StylesPath = .vale/styles

MinAlertLevel = suggestion

[*.md]
BasedOnStyles = Vale, Microsoft

And the GitHub workflow action:

---                                                                             
name: Linting with Vale on pull request                                         
 on:                                                                             
   - pull_request_target                                                         
 jobs:                                                                           
   vale:                                                                         
     name: Linting with Vale                                                     
     runs-on: ubuntu-latest                                                      
     steps:                                                                      
       - name: Checkout                                                          
         uses: actions/[email protected]                                           
       - name: Vale Linter                                                       
         uses: errata-ai/vale-action@reviewdog                                   
         with:                                                                   
           fail_on_error: true                                                   
         env:                                                                    
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} 

I fail to understand why the conclusion of running Vale with reviewdog is conclusion=success

Running vale with reviewdog 🐶 ...
  /github/home/vale --output=/lib/rdjsonl.tmpl .
  {"message": "[Microsoft.Adverbs] Consider removing 'very'.", "location": {"path": "docs/foo.md", "range": {"start": {"line": 1, "column": 5}}}, "severity": "WARNING"}
  {"message": "[Vale.Spelling] Did you really mean 'herrre'?", "location": {"path": "docs/foo.md", "range": {"start": {"line": 3, "column": 21}}}, "severity": "ERROR"}
  /bin/reviewdog -f=rdjsonl -name=vale -reporter=github-pr-check -fail-on-error=true -filter-mode=added -level=error
  2022/10/12 13:11:25 [vale] reported: https://github.com/volvo-cars/vale-test/runs/8846666662 (conclusion=success)

Any help debugging this issue is much appreciated 🙏🏼

pwalleni avatar Oct 12 '22 13:10 pwalleni

Did docs/foo.md meet the requirements for -filter-mode=added?

jdkato avatar Oct 12 '22 18:10 jdkato

Hi! Thanks for help me. I think it meets the requirement. I'm pushing commits to the PR, alternating creating a spelling error and fixing the spelling error in the same file. Basically, simulating the linter catching an error and the user correcting it. So this decoration confuses me:

image

pwalleni avatar Oct 12 '22 18:10 pwalleni

Is there a better support forum for this type of questions? Thanks.

pwalleni avatar Oct 17 '22 07:10 pwalleni

I got help over in Slack channel #testthedocs

pwalleni avatar Nov 08 '22 17:11 pwalleni