Repository navigation
Trim the readme.txt changelog under wordpress.org's word limit - #262
Conversation
wordpress.org truncates a readme Changelog section longer than 5,000 words and warns plugin committers on the plugin page. Ours was 5,202 words across 58 versions. It now lists 1.19.0 back to 1.10.0 (2,071 words) and ends with an "Earlier versions" entry linking to CHANGELOG.md on GitHub, which keeps the full history. Upgrade notices are unchanged. The release-readiness checklist gains an item to keep the section under the limit, with the command that counts it. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WPtgA1cnwP9mYKwaWniaFS
|
@codex review Generated by Claude Code |
Codex Review Summary: ✅ CompletedThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
Codex Review: Didn't find any major issues. Delightful! Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #262 +/- ##
=========================================
Coverage 88.68% 88.68%
Complexity 67 67
=========================================
Files 102 102
Lines 10990 10990
Branches 962 962
=========================================
Hits 9747 9747
Misses 445 445
Partials 798 798 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
What
The plugin page on wordpress.org shows committers this warning: "The Changelog section is too long and was truncated. A maximum of 5,000 words is supported." The
readme.txtchangelog had reached 5,202 words across 58 versions, so the oldest entries were being cut off without notice.readme.txtnow lists 1.19.0 back to 1.10.0 (2,071 words), then an Earlier versions entry that links toCHANGELOG.md, which keeps the full history. Upgrade notices are unchanged.docs/release-readiness-checklist.mdgets a checklist item to keep the section under the limit, with the command that counts it.CHANGELOG.mdgets an entry under Unreleased > Changed.wordpress.org reads the readme from the released tag, so the plugin page picks this up with the next release.
Checks
awk '/^== Changelog ==/{f=1} /^== Upgrade Notice ==/{f=0} f' readme.txt | wc -wgives 2,071.verify-metrics.shpasses, and Prettier is clean on the checklist.Generated by Claude Code