urllib3

1
name: Check
2

3
on:
4
  pull_request:
5
    types: [labeled, unlabeled, opened, reopened, synchronize]
6

7
permissions: "read-all"
8

9
jobs:
10
  check-changelog-entry:
11
    name: changelog entry
12
    runs-on: ubuntu-latest
13

14
    steps:
15
      - name: "Checkout repository"
16
        uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
17
        with:
18
          # `towncrier check` runs `git diff --name-only origin/main...`, which
19
          # needs a non-shallow clone.
20
          fetch-depth: 0
21

22
      - name: "Check changelog"
23
        if: "!contains(github.event.pull_request.labels.*.name, 'Skip Changelog')"
24
        run: |
25
          if ! pipx run towncrier check --compare-with origin/${{ github.base_ref }}; then
26
          echo "Please see https://github.com/urllib3/urllib3/blob/main/changelog/README.rst for guidance."
27
            false
28
          fi
29