Skip to content

Integrate automattic/jetpack-changelogger for changelog management#4

Open
datengraben wants to merge 3 commits into
masterfrom
claude/integrate-changelogger-plugin-V33OE
Open

Integrate automattic/jetpack-changelogger for changelog management#4
datengraben wants to merge 3 commits into
masterfrom
claude/integrate-changelogger-plugin-V33OE

Conversation

@datengraben

Copy link
Copy Markdown
Owner

Adds the WooCommerce/Automattic changelogger workflow so contributors
submit individual change files per PR instead of editing a shared
CHANGELOG.md, avoiding merge conflicts at release time.

  • Add automattic/jetpack-changelogger ^6.0 to require-dev
  • Configure changelogger in composer.json extra (keepachangelog format,
    semver versioning, GitHub compare link template)
  • Add composer scripts: changelog:add, changelog:validate, changelog:write
  • Create changelog/ directory (with .gitkeep) for per-PR change files
  • Create initial CHANGELOG.md seeded at v2.9
  • Add .github/workflows/changelog-check.yml to validate entries on PRs
  • Add .github/PULL_REQUEST_TEMPLATE.md with changelog checklist reminder

Developer workflow:
composer changelog:add # interactive wizard per PR
composer changelog:validate # run in CI
composer changelog:write # collapse entries at release time

https://claude.ai/code/session_01P1DDnvRKzHdx7jepeTf3ju

claude added 3 commits April 14, 2026 07:36
Adds the WooCommerce/Automattic changelogger workflow so contributors
submit individual change files per PR instead of editing a shared
CHANGELOG.md, avoiding merge conflicts at release time.

- Add `automattic/jetpack-changelogger ^6.0` to require-dev
- Configure changelogger in composer.json extra (keepachangelog format,
  semver versioning, GitHub compare link template)
- Add composer scripts: changelog:add, changelog:validate, changelog:write
- Create changelog/ directory (with .gitkeep) for per-PR change files
- Create initial CHANGELOG.md seeded at v2.9
- Add .github/workflows/changelog-check.yml to validate entries on PRs
- Add .github/PULL_REQUEST_TEMPLATE.md with changelog checklist reminder

Developer workflow:
  composer changelog:add       # interactive wizard per PR
  composer changelog:validate  # run in CI
  composer changelog:write     # collapse entries at release time

https://claude.ai/code/session_01P1DDnvRKzHdx7jepeTf3ju
- release.yml: run changelog:write on publish, extract the new version's
  notes from CHANGELOG.md, and backfill the GitHub release body via
  `gh release edit`; also commit the updated CHANGELOG.md back to the
  branch so the repo stays in sync
- changelog-check.yml: expand paths-ignore so PRs that only touch tests,
  CI config, tooling (composer.json, Gruntfile, etc.) or language files
  are not required to include a changelog entry — only user-facing src/
  template/asset changes trigger the requirement

https://claude.ai/code/session_01P1DDnvRKzHdx7jepeTf3ju
Adds a comprehensive CONTRIBUTING.md and fixes several friction points
that made it harder for new contributors to set up, test, and submit
changes.

CONTRIBUTING.md (new):
- Prerequisites table (PHP, Composer, Node, Docker)
- Quick start with wp-env credentials (admin/password)
- Correct step-by-step PHP unit test setup (DB port discovery → composer test)
- E2E test workflow
- Code standards section (composer lint / lint:fix)
- Changelog entry guide with significance/type table
- Branch naming, pre-PR checklist, and CI overview

composer.json:
- Add `lint` script (phpcs via .phpcs.xml.dist)
- Add `lint:fix` script (phpcbf)
- Add `test` script (dump-autoload + phpunit)

package.json:
- Fix `start` script to use `npm ci --legacy-peer-deps` (matches CI)
- Add `lint:php`, `lint:php:fix`, `test:php` proxy scripts into composer

Readme.md:
- Remove "only works with manually downloaded phar" outdated note
- Replace manual PHPUnit invocation with `composer test`
- Add wp-env login credentials
- Add `composer lint` to the development section
- Link to CONTRIBUTING.md from the Contribute section

.github/actions/build-plugin/action.yml:
- Upgrade actions/cache v3 → v4
- Upgrade actions/setup-node v3 → v4 (matches all other workflows)

https://claude.ai/code/session_01P1DDnvRKzHdx7jepeTf3ju
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.

2 participants