fix: #1846 reference canvas docs #1056
Workflow file for this run
This file contains hidden or 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: Docs Check | |
| on: | |
| pull_request: | |
| types: [opened, synchronize, reopened, edited] | |
| jobs: | |
| docs-check: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| pull-requests: read | |
| steps: | |
| - name: Check docs requirements | |
| uses: actions/github-script@v7 | |
| with: | |
| script: | | |
| if (/\[x\].*no docs needed/i.test(context.payload.pull_request.body || '')) { | |
| core.info('🟡 "No Docs Needed" checked — skipping docs enforcement.'); | |
| return; | |
| } | |
| if (context.payload.pull_request.user.login === 'dependabot[bot]') { | |
| core.info('🤖 Dependabot PR detected — skipping docs enforcement.'); | |
| return; | |
| } | |
| const filenames = (await github.rest.pulls.listFiles({ | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| pull_number: context.payload.pull_request.number | |
| })).data.map(f => f.filename); | |
| if (filenames.some(f => f.startsWith('docs/stable/'))) { | |
| core.setFailed('❌ Changes to "stable" documentation are not allowed. Please make changes in the "development" directory instead.'); | |
| return; | |
| } | |
| if (filenames.some(f => /\.mdx?$/.test(f))) { | |
| core.info('✅ Docs updated.'); | |
| } else { | |
| core.setFailed('❌ No docs changes found and "No Docs Needed" not checked.'); | |
| } |