|
| 1 | +name: Check Draftlog |
| 2 | + |
| 3 | +on: |
| 4 | + pull_request: |
| 5 | + types: [opened, reopened, synchronize, labeled, unlabeled, ready_for_review] |
| 6 | + |
| 7 | +concurrency: |
| 8 | + group: check-draftlog-${{ github.event.pull_request.number }} |
| 9 | + cancel-in-progress: true |
| 10 | + |
| 11 | +permissions: |
| 12 | + contents: read |
| 13 | + pull-requests: read |
| 14 | + |
| 15 | +jobs: |
| 16 | + check-draftlog: |
| 17 | + if: github.event.pull_request.draft == false |
| 18 | + runs-on: ubuntu-latest |
| 19 | + steps: |
| 20 | + - name: Check for no-draftlog label |
| 21 | + id: label-check |
| 22 | + env: |
| 23 | + PR_LABELS: ${{ toJson(github.event.pull_request.labels.*.name) }} |
| 24 | + run: | |
| 25 | + set -euo pipefail |
| 26 | + if echo "$PR_LABELS" | grep -q '"no-draftlog"'; then |
| 27 | + echo "Skipping draftlog check: 'no-draftlog' label is set." |
| 28 | + echo "skip=true" >> "$GITHUB_OUTPUT" |
| 29 | + fi |
| 30 | +
|
| 31 | + - name: Check for a new draftlog entry |
| 32 | + if: steps.label-check.outputs.skip != 'true' |
| 33 | + env: |
| 34 | + GH_TOKEN: ${{ github.token }} |
| 35 | + REPO: ${{ github.repository }} |
| 36 | + PR_NUMBER: ${{ github.event.pull_request.number }} |
| 37 | + HEAD_SHA: ${{ github.event.pull_request.head.sha }} |
| 38 | + run: | |
| 39 | + set -euo pipefail |
| 40 | +
|
| 41 | + ADDED=$(gh api --paginate "/repos/$REPO/pulls/$PR_NUMBER/files" \ |
| 42 | + --jq '.[] | select(.status=="added") | .filename' \ |
| 43 | + | grep '^draftlogs/' | grep -v '^draftlogs/README\.md$' || true) |
| 44 | +
|
| 45 | + if [ -z "$ADDED" ]; then |
| 46 | + echo "::error::No new draftlog entry was added under draftlogs/." |
| 47 | + echo "" |
| 48 | + echo "Most PRs should add a markdown file under draftlogs/ for the next CHANGELOG." |
| 49 | + echo "See draftlogs/README.md for the filename convention." |
| 50 | + echo "" |
| 51 | + echo "If this PR genuinely does not need a changelog entry (e.g. CI-only," |
| 52 | + echo "internal refactor, docs typo), add the 'no-draftlog' label to this PR." |
| 53 | + exit 1 |
| 54 | + fi |
| 55 | +
|
| 56 | + INVALID_NAMES=$(echo "$ADDED" | grep -vE '^draftlogs/[0-9]+_(fix|add|remove|change|deprecate)\.md$' || true) |
| 57 | + if [ -n "$INVALID_NAMES" ]; then |
| 58 | + echo "::error::Invalid draftlog filename(s):" |
| 59 | + echo "$INVALID_NAMES" | sed 's/^/ - /' |
| 60 | + echo "" |
| 61 | + echo "Expected pattern: draftlogs/<number>_(fix|add|remove|change|deprecate).md" |
| 62 | + echo "See draftlogs/README.md for details." |
| 63 | + exit 1 |
| 64 | + fi |
| 65 | +
|
| 66 | + MISSING_LINK="" |
| 67 | + while IFS= read -r f; do |
| 68 | + [ -z "$f" ] && continue |
| 69 | + content=$(gh api -H 'Accept: application/vnd.github.raw' "/repos/$REPO/contents/$f?ref=$HEAD_SHA") |
| 70 | + if ! echo "$content" | grep -qE '\[\[#[0-9]+\]\(https://github\.com/plotly/plotly\.js/pull/[0-9]+\)\]'; then |
| 71 | + MISSING_LINK="$MISSING_LINK$f"$'\n' |
| 72 | + fi |
| 73 | + done <<< "$ADDED" |
| 74 | +
|
| 75 | + if [ -n "$MISSING_LINK" ]; then |
| 76 | + echo "::error::Draftlog entry(ies) missing a PR link:" |
| 77 | + printf '%s' "$MISSING_LINK" | sed 's/^/ - /' |
| 78 | + echo "" |
| 79 | + echo "Each entry must include a link in the form:" |
| 80 | + echo " [[#1234](https://github.com/plotly/plotly.js/pull/1234)]" |
| 81 | + echo "See draftlogs/README.md for an example." |
| 82 | + exit 1 |
| 83 | + fi |
| 84 | +
|
| 85 | + echo "Found new draftlog entry(ies):" |
| 86 | + echo "$ADDED" | sed 's/^/ - /' |
0 commit comments