feat(ci): add workflow for broken links check #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: spellcheck | |
| on: | |
| pull_request: | |
| jobs: | |
| run: | |
| name: Spell Check with Typos | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: typos-action | |
| id: typos-output | |
| uses: crate-ci/[email protected] | |
| with: | |
| config: ./typos.toml | |
| - name: Find Comment | |
| if: ${{ failure() }} | |
| uses: peter-evans/find-comment@v3 | |
| id: find-comment | |
| with: | |
| issue-number: ${{ github.event.pull_request.number }} | |
| comment-author: "github-actions[bot]" | |
| body-includes: The CI check for spelling has failed | |
| - name: Create comment on PR if typos fail | |
| if: ${{ failure() && steps.find-comment.outputs.comment-id == '' }} | |
| uses: peter-evans/create-or-update-comment@v4 | |
| with: | |
| issue-number: ${{ github.event.pull_request.number }} | |
| body: | | |
| ### CI Check Failed | |
| The CI check for spelling has failed. Please review the errors and correct any spelling mistakes. | |
| For more errors and details, you can check the [CI Log](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}) or you can install [typos](https://github.com/crate-ci/typos?tab=readme-ov-file#install) and run `typos` locally to check for and fix spelling issues. | |
| - name: Update comment if typos fail | |
| if: ${{ failure() && steps.find-comment.outputs.comment-id != '' }} | |
| uses: peter-evans/create-or-update-comment@v4 | |
| with: | |
| comment-id: ${{ steps.find-comment.outputs.comment-id }} | |
| issue-number: ${{ github.event.pull_request.number }} | |
| body: | | |
| ### CI Check Failed | |
| The CI check for spelling has failed. Please review the errors and correct any spelling mistakes. | |
| For more errors and details, you can check the [CI Log](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}) or you can install [typos](https://github.com/crate-ci/typos?tab=readme-ov-file#install) and run `typos` locally to check for and fix spelling issues. | |
| edit-mode: replace | |
| - name: Check Spelling | |
| uses: rojopolis/[email protected] | |
| with: | |
| config_path: .spellcheck.yml | |
| task_name: Markdown |