test vale gha pr #79
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Lint and suggest | |
| on: | |
| pull_request: | |
| paths: | |
| - '**/*.md' | |
| jobs: | |
| vale: # Vale linting job | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 # Fetch all history so we can access all commits | |
| - name: Install Vale | |
| uses: errata-ai/vale-action@v2 | |
| - name: Install jq | |
| run: sudo apt-get install -y jq | |
| - name: Get changed files | |
| id: changed-files | |
| run: | | |
| BASE_SHA=$(git merge-base origin/${{ github.event.pull_request.base.ref }} ${{ github.sha }}) | |
| CHANGED_FILES=$(git diff --name-only $BASE_SHA ${{ github.sha }} -- '*.md') | |
| echo "CHANGED_FILES=$CHANGED_FILES" >> $GITHUB_ENV | |
| echo "::set-output name=files::$(echo $CHANGED_FILES | jq -R -s -c 'split("\n")[:-1]')" | |
| - name: Print Changed Files | |
| run: echo $CHANGED_FILES | |
| - name: Run Vale on changed files | |
| run: | | |
| echo "[]" > rdjson_output.jsonl | |
| for file in $(echo "${{ steps.changed-files.outputs.files }}" | jq -r '.[]'); do | |
| echo "Running Vale on $file" | |
| vale_output=$(vale --output=JSON "$file") | |
| if [ $? -eq 0 ]; then | |
| echo "$vale_output" | jq -c --arg file "$file" '.[] | {file: $file, line: .Line, column: .Span[0], message: .Message, suggestion: (.Suggestions[0] // "")}' >> rdjson_output.jsonl | |
| else | |
| echo "Error processing $file" | |
| fi | |
| done | |
| echo "Vale output:" | |
| cat rdjson_output.jsonl | |
| env: | |
| REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.REVIEWDOG_GITHUB_API_TOKEN }} | |
| - name: Upload Vale results | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: vale-results | |
| path: rdjson_output.jsonl | |
| suggest: # Reviewdog suggestion job | |
| runs-on: ubuntu-latest | |
| needs: vale # This ensures the suggest job runs after the vale job | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v3 | |
| - name: Download Vale results | |
| uses: actions/download-artifact@v3 | |
| with: | |
| name: vale-results | |
| - name: Run Reviewdog Suggestion Action | |
| uses: reviewdog/action-suggester@v1 | |
| with: | |
| github_token: ${{ secrets.REVIEWDOG_GITHUB_API_TOKEN }} | |
| tool_name: Vale | |
| level: "warning" | |
| filter_mode: "diff_context" | |
| fail_on_error: "false" | |
| reviewdog_flags: "" | |
| cleanup: "true" | |
| - name: Run Reviewdog with Vale results | |
| run: | | |
| reviewdog -f=rdjsonl -name="Vale" -reporter=github-pr-review -level=warning -filter-mode=nofilter < rdjson_output.jsonl | |
| env: | |
| REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.REVIEWDOG_GITHUB_API_TOKEN }} |