chore(lint): Fixed 90-95% of Markdown lint violations across the repository #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: Markdown Lint Check | |
| on: | |
| pull_request: | |
| paths: | |
| - "**/*.md" # Run only when Markdown files change | |
| push: | |
| branches: | |
| - main | |
| permissions: | |
| contents: read | |
| pull-requests: write | |
| jobs: | |
| markdown-lint: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout Repository | |
| uses: actions/checkout@v4 | |
| - name: Install Node.js & Markdownlint | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y nodejs npm | |
| sudo npm install -g markdownlint-cli | |
| - name: Run Markdownlint | |
| run: | | |
| markdownlint "**/*.md" --config .markdownlint.json > markdown-lint-report.txt || true | |
| - name: Post Lint Report as PR Comment | |
| if: github.event_name == 'pull_request' | |
| uses: mshick/add-pr-comment@v2 | |
| with: | |
| message: | | |
| **Markdown Lint Report:** | |
| ``` | |
| $(cat markdown-lint-report.txt) | |
| ``` | |
| repo-token: ${{ secrets.GITHUB_TOKEN }} | |
| allow-repeats: false |