changelog-check.yml

name: Require changelog

on:
  pull_request:
    types:
      # On by default if types not specified:
      - "opened"
      - "reopened"
      - "synchronize"

      # For `skip-label` handling:
      - "labeled"
      - "unlabeled"

permissions:
  pull-requests: write

jobs:
  check-changelog:
    name: Check for changelog
    runs-on: ubuntu-latest
    if: ${{ github.actor != 'renovate[bot]' }}
    steps:
      - name: Check
        uses: brettcannon/check-for-changed-files@v1.2.1
        # Run only if PR body doesn't contain '[skip changelog]'.
        if: ${{ !contains(github.event.pull_request.body, '[skip changelog]') }}
        with:
          file-pattern: |
            .changes/unreleased/*.yaml
            CHANGELOG.md
          skip-label: "skip changelog"
          token: ${{ secrets.GITHUB_TOKEN }}
          failure-message: >-
            Missing a changelog file in ${file-pattern};
            please add one or apply the ${skip-label} label to the pull request
            if a changelog entry is not needed.