Skip to content

fix(external docs): render all top level configuration fields #21672

fix(external docs): render all top level configuration fields

fix(external docs): render all top level configuration fields #21672

Workflow file for this run

# Changelog
#
# Validates that a changelog entry was added.
# Runs on PRs when:
# - opened/re-opened
# - new commits pushed
# - label is added or removed
# Runs on merge queues, but just passes, because it is a required check.
name: Changelog
on:
pull_request:
types: [opened, synchronize, reopened, labeled, unlabeled]
# Required by GitHub merge queue due to branch protection rules. Should always be successful
merge_group:
types: [checks_requested]
permissions:
contents: read
jobs:
validate-changelog:
permissions:
contents: read
pull-requests: none
runs-on: ubuntu-24.04
env:
NO_CHANGELOG: ${{ contains(github.event.pull_request.labels.*.name, 'no-changelog') }}
SHOULD_RUN: ${{ !contains(github.event.pull_request.labels.*.name, 'no-changelog') && github.event_name != 'merge_group' }}
steps:
- name: Bypass when no‑changelog label is present
if: env.NO_CHANGELOG == 'true'
run: |
echo "'no-changelog' label detected – skipping changelog validation."
exit 0
- name: Merge queue
if: ${{ github.event_name == 'merge_group' }}
run: |
echo "merge_group event – passing without running changelog validation."
exit 0
# Checkout PR branch (includes script and changelog.d/)
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
if: env.SHOULD_RUN == 'true'
- name: Run changelog fragment checker
if: env.SHOULD_RUN == 'true'
run: |
# Compare against origin/master
./scripts/check_changelog_fragments.sh