refactor: refactor outline and docs level #8
Workflow file for this run
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 | |
on: | |
push: | |
branches: | |
- '*' | |
pull_request: | |
branches: | |
- '*' | |
paths: | |
- '**/*.md' # Only run on Markdown file changes | |
jobs: | |
markdown-lint: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout code | |
uses: actions/checkout@v4 | |
- name: Install zhlint | |
run: yarn global add zhlint | |
- name: Get changed Markdown files | |
id: changed-files | |
uses: tj-actions/changed-files@v45 | |
with: | |
files: '**/*.md' | |
- name: Lint Markdown files | |
env: | |
ALL_CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }} | |
run: | | |
mkdir -p linted_output | |
file_list="linted_output/file_list.txt" | |
linted_failed=0 | |
for file in ${{ env.ALL_CHANGED_FILES }}; do | |
set +e | |
zhlint --config "$GITHUB_WORKSPACE"/.github/workflows/.zhlintrc "$file" | |
if [ $? -ne 0 ]; then | |
linted_failed=1 | |
echo "$file" >> "$file_list" | |
output_file="linted_output/report_and_suggested_fixes/$file" | |
mkdir -p "$(dirname "$output_file")" | |
zhlint --config "$GITHUB_WORKSPACE"/.github/workflows/.zhlintrc "$file" --output="$output_file" > "$output_file.log" 2>&1 | |
fi | |
set -e | |
done | |
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 the job [Lint Markdown files]. Otherwise, you can download report files in uploaded artifact." | |
exit 1 | |
fi |