Skip to content

GitHub Actions: Warn if docs manifest possibly outdated #232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 12, 2025
Merged

GitHub Actions: Warn if docs manifest possibly outdated #232

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
174afad
GitHub Actions: Fail if docs manifest outdated
mcsf Nov 11, 2025
3cb1c4b
Run on all PR events and for any change in docs/**
mcsf Nov 12, 2025
502ded3
Skip composer install
mcsf Nov 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions .github/workflows/docs-manifest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Keep docs manifest up to date
on:
Copy link
Contributor Author

@mcsf mcsf Nov 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The on config here is what diverges the most from the other workflows. Initially, based on Gutenberg's components-changelog workflow, I wanted this check to be more conservative.

But now that I look at it again, and given the approach I finally took, maybe it should be the same as in the others. Thoughts?

Copy link
Contributor

@priethor priethor Nov 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me like this. What do you think could be different?

Copy link
Contributor Author

@mcsf mcsf Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wasn't sure about the preferences — if any — for the branches property, nor about which workflows should also run on push events. But I'm about to push a simplification here, limiting the workflow to pull_request events and looking more like other workflows.

Copy link
Contributor

@priethor priethor Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request events sound good, regenerating the manifest should be enforces for PRs that target trunk 👍

pull_request:
branches:
- trunk
paths:
- docs/**

jobs:
check-docs-manifest:
name: Check docs manifest for staleness
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.4'
tools: composer:v2

- name: Regenerate manifest
run: composer run docs:manifest

- name: Check whether manifest has been updated
env:
MANIFEST_PATH: docs/bin/manifest.json
run: |
if ! git diff --quiet -- "$MANIFEST_PATH"; then
echo "There are documentation changes in this branch that require that the docs manifest be regenerated."
echo
echo "Please run 'composer run docs:manifest' and commit $MANIFEST_PATH"
exit 1
fi
Loading