Hackathon docs #266
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: Require Docs Update | |
| on: | |
| pull_request: | |
| types: [opened, synchronize, reopened, ready_for_review] | |
| jobs: | |
| docs-check: | |
| runs-on: ubuntu-latest | |
| if: github.event.pull_request.draft == false | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 # full history for diff | |
| - name: Fetch base branch | |
| run: git fetch origin ${{ github.event.pull_request.base.ref }} --depth=1 | |
| - name: Check for .mdx changes in docs/ | |
| id: docs_check | |
| run: | | |
| git fetch origin +refs/heads/${{ github.event.pull_request.base.ref }}:refs/remotes/origin/${{ github.event.pull_request.base.ref }} | |
| base_sha=$(git merge-base origin/${{ github.event.pull_request.base.ref }} HEAD) | |
| head_sha=$(git rev-parse HEAD) | |
| echo "Base SHA: $base_sha" | |
| echo "Head SHA: $head_sha" | |
| changed_files=$(git diff --name-only "$base_sha" "$head_sha" | grep '^docs/.*\.mdx$' | wc -l) | |
| echo "changed_docs_count=$changed_files" >> $GITHUB_OUTPUT | |
| if [ "$changed_files" -eq 0 ]; then | |
| echo "❌ PR does not include updates to docs/*.mdx files. Please add or modify documentation." >&2 | |
| exit 1 | |
| else | |
| echo "✅ Documentation updated ($changed_files file(s))." | |
| fi |