-
Notifications
You must be signed in to change notification settings - Fork 968
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b05396c
commit dc6a399
Showing
1 changed file
with
31 additions
and
111 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,121 +1,41 @@ | ||
name: Lint and suggest | ||
name: Vale Linting and Suggestions | ||
|
||
on: | ||
pull_request: | ||
paths: | ||
- '**/*.md' | ||
|
||
jobs: | ||
vale: # Vale linting job | ||
vale-lint: | ||
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 "CHANGED_FILES=$(echo $CHANGED_FILES | jq -R -s -c 'split(\"\n\")[:-1]')" >> $GITHUB_ENV | ||
- name: Print Changed Files | ||
run: echo $CHANGED_FILES | ||
|
||
- name: Run Vale on changed files | ||
run: | | ||
for file in ${{ env.CHANGED_FILES }}; do | ||
echo "Running Vale on $file" | ||
vale --output=JSON $file > "vale_output_${file//\//_}.json" | ||
vale --output=edit $file > "vale_output_${file//\//_}_edit.md" | ||
done | ||
echo "Vale outputs:" | ||
ls -l | ||
- name: Apply Vale edits and save originals | ||
run: | | ||
mkdir -p original_files | ||
mkdir -p corrected_files | ||
for file in ${{ env.CHANGED_FILES }}; do | ||
echo "Copying $file to original_files/${file//\//_}.original" | ||
cp "$file" "original_files/${file//\//_}.original" | ||
echo "Copying vale_output_${file//\//_}_edit.md to corrected_files/${file//\//_}" | ||
cp "vale_output_${file//\//_}_edit.md" "corrected_files/${file//\//_}" | ||
done | ||
echo "Original files:" | ||
ls -l original_files | ||
echo "Corrected files:" | ||
ls -l corrected_files | ||
env: | ||
REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.REVIEWDOG_GITHUB_API_TOKEN }} | ||
|
||
- name: Upload original files | ||
uses: actions/upload-artifact@v3 | ||
with: | ||
name: original-files | ||
path: original_files/ | ||
|
||
- name: Upload corrected files | ||
uses: actions/upload-artifact@v3 | ||
with: | ||
name: corrected-files | ||
path: corrected_files/ | ||
|
||
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 original files | ||
uses: actions/download-artifact@v3 | ||
with: | ||
name: original-files | ||
|
||
- name: Download corrected files | ||
uses: actions/download-artifact@v3 | ||
with: | ||
name: corrected-files | ||
|
||
- name: List downloaded files | ||
run: | | ||
echo "Original files:" | ||
ls -l original_files | ||
echo "Corrected files:" | ||
ls -l corrected_files | ||
- 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 corrected files | ||
run: | | ||
for file in original_files/*.original; do | ||
original="$file" | ||
corrected="corrected_files/$(basename "$file" .original)" | ||
diff_output=$(diff -u "$original" "$corrected") | ||
if [[ -n "$diff_output" ]]; then | ||
echo "$diff_output" | reviewdog -f=diff -name="Vale" -reporter=github-pr-review -level=warning -filter-mode=nofilter | ||
fi | ||
done | ||
env: | ||
REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.REVIEWDOG_GITHUB_API_TOKEN }} | ||
- name: Checkout code | ||
uses: actions/checkout@v2 | ||
|
||
- name: Set up Vale | ||
run: | | ||
curl -sfL https://install.goreleaser.com/github.com/errata-ai/vale.sh | sh -s -- -b $HOME/.local/bin | ||
echo "$HOME/.local/bin" >> $GITHUB_PATH | ||
- name: Run Vale | ||
run: | | ||
vale --output=JSON . > vale_output.json | ||
- name: Install jq | ||
run: sudo apt-get install -y jq | ||
|
||
- name: Process Vale Output for Reviewdog | ||
run: | | ||
jq -c '.[] | {file: .Path, line: .Line, column: .Span[0], message: .Message, suggestion: .Suggestions[0], severity: .Severity}' vale_output.json > rdjson_output.jsonl | ||
- name: Reviewdog - Report results and Suggest changes | ||
uses: reviewdog/action-suggester@v1 | ||
with: | ||
tool_name: vale | ||
level: warning | ||
reporter: github-pr-review | ||
filter_mode: added | ||
fail_on_error: true | ||
input_file: rdjson_output.jsonl | ||
github_token: ${{ secrets.REVIEWDOG_GITHUB_API_TOKEN }} |