Skip to content

ci(docs): remove permanently red catalog freshness check - #10972

Closed
proggeramlug wants to merge 2 commits into
mainfrom
fix/10955-docs-gettext
Closed

proggeramlug wants to merge 2 commits into
mainfrom
fix/10955-docs-gettext

Conversation

@proggeramlug

@proggeramlug proggeramlug commented Sep 22, 2026 •

Copy link
Copy Markdown
Contributor

Fixes #10955.

The Docs checks job regenerated every gettext catalog and required a byte-for-byte clean diff. This has been permanently red: gettext rewraps obsolete #~ entries, and the catalogs on main also contain active drift after a prior mass regeneration was reverted because it removed existing translations (43200e9d41). Filtering obsolete entries alone therefore cannot make this check pass. As the issue proposes, this removes the freshness gate while retaining msgfmt syntax/format validation and the English plus all-translations build. The job is renamed to match what it now checks.

Validation:

  • msgfmt --check --check-format --statistics passes for all ten .po catalogs.
  • PATH=/tmp/perry-mdbook-054:$PATH ./docs/i18n.sh build-all builds English and all ten translations with mdBook v0.5.4 and mdbook-i18n-helpers v0.4.0.
  • git diff --check passes.
  • GitHub Docs checks build-and-validation passed on the PR head: https://github.com/PerryTS/perry/actions/runs/35726226687

@coderabbitai

coderabbitai Bot commented Sep 22, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 3a8a183f-4a23-4ab9-8f1f-babd35989987

📥 Commits

Reviewing files that changed from the base of the PR and between c1569e2 and 8d9cf70.

📒 Files selected for processing (2)
  • .github/workflows/docs-check.yml
  • changelog.d/10972-docs-catalog-validation.md

Included review availability: Your plan provides up to 8 included reviews per hour; 2 remain after this review.


📝 Walkthrough

Walkthrough

The documentation workflow now validates committed gettext catalogs with msgfmt instead of regenerating them. The workflow job name changed, and the changelog documents the new validation behavior.

Changes

Documentation workflow validation

Layer / File(s) Summary
Catalog validation workflow
.github/workflows/docs-check.yml, changelog.d/10972-docs-catalog-validation.md
The job is renamed to build-and-validation. The workflow validates each existing catalog with msgfmt without regenerating files. The changelog records the change.

Priority: ➖ Normal

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Bug fix · Severity of issue fixed: Medium

Merge Risk: ⚪ Minimal · up to 8d9cf

The workflow now validates committed catalogs and builds all translations without failing on harmless obsolete-entry reformatting, so the change is ready to merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Linked Issues check ✅ Passed The PR addresses #10955 by removing the permanently failing catalog freshness diff check. The workflow now validates each committed catalog with msgfmt --check --check-format --statistics and retain…
Out of Scope Changes check ✅ Passed The changes are limited to the Docs workflow and a changelog entry. Renaming the job and documenting catalog validation directly support #10955. No unrelated implementation changes are shown.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Title check ✅ Passed The title clearly identifies the primary change: removing the permanently failing documentation catalog freshness check.
Description check ✅ Passed The description explains the problem, the implemented workflow changes, the linked issue, and the validation results. It does not reproduce every template heading or checklist item, but it contains th…
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@proggeramlug

Copy link
Copy Markdown
Contributor Author

Landed on main in merge train 256 (#11018, v0.5.1638), main f5cfbff882.

Carried at head 8d9cf7094e. The landed tree is byte-identical to the validated train tree (9b108dd3c9), and CI on the train head passed every job except the known public-baseline lint step: all 6 gap shards, cargo-test, e2e-scoped, gc-stress, check, warnings and security-audit green.

Trains rebase-merge, so commits get new SHAs and GitHub cannot mark this PR merged. Closed as landed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs checks / build-and-freshness is permanently red on stale gettext catalogs (rewrapping only)

1 participant