Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(ci): lint all Markdown files #243

Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions .github/workflows/lint-all.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Lint All

on:
workflow_dispatch:

jobs:
lint:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Install zhlint
run: yarn global add zhlint

- name: Lint all Markdown files
run: |
mkdir -p linted_output
file_list="linted_output/file_list.txt"
linted_failed_file=$(mktemp)
echo 0 > "$linted_failed_file"
find . -type f -name '*.md' | while read -r file; do
set +e
zhlint "$file"
if [ $? -ne 0 ]; then
echo 1 > "$linted_failed_file"
echo "$file" >> "$file_list"
output_file="linted_output/report_and_suggested_fixes/$file"
mkdir -p "$(dirname "$output_file")"
zhlint "$file" --output="$output_file" > "$output_file.log" 2>&1
fi
set -e
done
linted_failed=$(cat "$linted_failed_file")
rm "$linted_failed_file"
echo "linted_failed=$linted_failed" >> "$GITHUB_ENV"

- name: Upload linted Markdown
uses: actions/upload-artifact@v4
with:
name: linted-markdown
path: linted_output/

- name: Check lint errors
run: |
set -e
if [ "${{ env.linted_failed }}" -ne 0 ]; then
echo "Linting errors found. Please check the reports and suggested fixes in uploaded artifact."
exit 1
fi