Skip to content

documentation: update the README for CI, releases and data - #102

Merged
mukeshpanchal27 merged 1 commit into
trunkfrom
documentation/readme-update
Nov 4, 2026
Merged

mukeshpanchal27 merged 1 commit into
trunkfrom
documentation/readme-update

Conversation

@mukeshpanchal27

Copy link
Copy Markdown
Owner

Change

I compared README.md with the repo as it is now.

Fixed:

  • Status: it said "Version 1.0.0 is the first release for wordpress.org". The plugin is not submitted yet, so it now says it is ready but not submitted.
  • Install command: npm install is now npm ci, which installs exactly the versions in package-lock.json. This fits the npm exec --no -- rule. composer install is now part of the first setup, because the tests need it.

New sections:

  • Data and uninstall: what a report stores, and what deleting the plugin removes. This text was only in readme.txt.
  • Coding standards: composer lint and composer format.
  • Continuous integration: a table of all 8 workflows. It also covers the rule to pin actions to commit hashes with exact tag comments, from chore: pin all GitHub Actions to commit hashes #101, and the Dependabot schedule.
  • Releasing: bin/build-zip.sh, npm run assets:wordpress-org, the version tag, and a link to docs/releasing.md.
  • Documentation: links to both decision records, the security review and the release guide.

New limits:

Not changed

The overhead numbers stay as measured in #91. The code changes since then add a file comparison on admin page loads only, which does not touch the front end.

🤖 Generated with Claude Code

Fix the release status, and add sections on data and uninstall, coding
standards, continuous integration, releasing and the docs. Add two
missing limits, and install with npm ci.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Nov 4, 2026

Copy link
Copy Markdown

✅ WordPress Plugin Check Report

✅ Status: Passed

📊 Report

All checks passed! No errors or warnings found.


🤖 Generated by WordPress Plugin Check Action • Learn more about Plugin Check

@mukeshpanchal27
mukeshpanchal27 merged commit a027f3d into trunk Nov 4, 2026
14 checks passed
@mukeshpanchal27
mukeshpanchal27 deleted the documentation/readme-update branch November 4, 2026 05:03
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.

1 participant