check-news.yml

Enforce a changelog entry on each pull request (wraps UCD-SERG/changelog-check-action).

Inputs

Input	Type	Default	Description
changelog	string	'NEWS.md'	Path to the changelog file to check.
no-changelog-label	string	'no-changelog'	PR label that skips this workflow’s own changelog check. Set to an empty string to disable this workflow’s escape hatch. The wrapped UCD-SERG/changelog-check-action separately, unconditionally recognizes its own hardcoded no changelog (space) label - not controlled by this input.

Permissions

Only contents: read (the default), so no permissions: block is needed.

Example

# Copy to .github/workflows/news.yaml in your repo.
name: Check NEWS.md Changelog

on:
  pull_request:
    types: [assigned, opened, synchronize, reopened, labeled, unlabeled]
    branches:
      - main

jobs:
  check:
    uses: Morrison-Lab/gha/.github/workflows/check-news.yml@v2
    # with:
    #   changelog: NEWS.md
    #   no-changelog-label: no-changelog

See examples/check-news.yml for the full caller stub.