|
| 1 | +name: Check PR CHANGELOG.md |
| 2 | + |
| 3 | +# Separate check PR, because of triggers both at code update and at comment update |
| 4 | +on: |
| 5 | + pull_request: |
| 6 | + types: [opened, reopened, synchronize, edited] |
| 7 | + |
| 8 | +concurrency: |
| 9 | + group: "${{ github.workflow }}-${{ github.head_ref || github.ref }}" |
| 10 | + cancel-in-progress: true |
| 11 | + |
| 12 | +permissions: |
| 13 | + pull-requests: write |
| 14 | + |
| 15 | +jobs: |
| 16 | + changelog_modification_consistency: |
| 17 | + name: CHANGELOG.md needs to be modified if indicated |
| 18 | + if: (github.event.pull_request.user.login != 'dependabot[bot]') && (github.event.pull_request.user.login != 'renovate-bot') |
| 19 | + runs-on: ubuntu-latest |
| 20 | + steps: |
| 21 | + - uses: actions/checkout@v5 |
| 22 | + with: |
| 23 | + fetch-depth: 0 |
| 24 | + - name: Check PR body for changelog note |
| 25 | + id: changelog_check |
| 26 | + run: | |
| 27 | + BODY=$(gh pr view "${{ github.event.number }}" --json body --template '{{.body}}') |
| 28 | + echo "Body: $BODY" |
| 29 | +
|
| 30 | + if echo "$BODY" | grep -q '\- \[x\] I described the change in `CHANGELOG.md`'; then |
| 31 | + echo "found" |
| 32 | + echo "found=yes" >> $GITHUB_OUTPUT |
| 33 | + else |
| 34 | + echo "not found" |
| 35 | + echo "found=no" >> $GITHUB_OUTPUT |
| 36 | + fi |
| 37 | + env: |
| 38 | + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
| 39 | + - name: CHANGELOG.md modified |
| 40 | + id: changelog_modified |
| 41 | + uses: tj-actions/changed-files@24d32ffd492484c1d75e0c0b894501ddb9d30d62 # v47 |
| 42 | + with: |
| 43 | + files: | |
| 44 | + CHANGELOG.md |
| 45 | + - name: Check for CHANGELOG.md modifications |
| 46 | + id: check_changelog_modification |
| 47 | + run: | |
| 48 | + set -euo pipefail |
| 49 | + found="${{ steps.changelog_check.outputs.found }}" |
| 50 | + any_changed="${{ steps.changelog_modified.outputs.any_changed }}" |
| 51 | +
|
| 52 | + echo "found=${found}" |
| 53 | + echo "any_changed=${any_changed}" |
| 54 | +
|
| 55 | + if [[ "${any_changed}" == "true" && "${found}" != "yes" ]]; then |
| 56 | + echo "❌ CHANGELOG.md modified, but not indicated in checklist" |
| 57 | + exit 1 |
| 58 | + fi |
| 59 | +
|
| 60 | + if [[ "${any_changed}" != "true" && "${found}" == "yes" ]]; then |
| 61 | + echo "❌ CHANGELOG.md NOT modified, but indicated in checklist" |
| 62 | + exit 1 |
| 63 | + fi |
| 64 | +
|
| 65 | + if [[ "${any_changed}" == "true" && "${found}" == "yes" ]]; then |
| 66 | + echo "✅ CHANGELOG.md was modified and indicated in checklist" |
| 67 | + else |
| 68 | + echo "✅ CHANGELOG.md was NOT modified and NOT indicated in checklist" |
| 69 | + fi |
| 70 | +
|
| 71 | + upload-pr-number: |
| 72 | + runs-on: ubuntu-latest |
| 73 | + steps: |
| 74 | + - name: Create pr_number.txt |
| 75 | + run: echo "${{ github.event.number }}" > pr_number.txt |
| 76 | + - uses: actions/upload-artifact@v4 |
| 77 | + with: |
| 78 | + name: pr_number |
| 79 | + path: pr_number.txt |
| 80 | + |
0 commit comments