Skip to content

Add automated changelog system and WordPress.org deploy#633

Merged
akirk merged 2 commits into
mainfrom
feature/changelog-and-deploy
Apr 1, 2026
Merged

Add automated changelog system and WordPress.org deploy#633
akirk merged 2 commits into
mainfrom
feature/changelog-and-deploy

Conversation

@akirk

@akirk akirk commented Mar 29, 2026

Copy link
Copy Markdown
Owner

Summary

  • Adds a per-PR changelog entry system (.github/changelog/unreleased/) with enforcement via GitHub Actions
  • Automates WordPress.org SVN deployment via the 10up deploy action, triggered on GitHub release
  • The deploy workflow also handles version bumping and changelog compilation — the entire release process is now: create a GitHub release with a version tag

Changes

  • .github/workflows/changelog.yml — enforces changelog entries on PRs, can auto-create from PR description checkboxes
  • .github/workflows/deploy.yml — on release: compiles changelog, bumps version, commits to main, deploys to WordPress.org
  • .github/PULL_REQUEST_TEMPLATE.md — PR template with changelog section
  • bin/changelog-add.sh — interactive helper to create changelog entries
  • bin/changelog-write.sh — compiles unreleased entries into CHANGELOG.md and README.md
  • bin/version-bump.sh — updates version in friends.php and README.md
  • docs/release-process.md — documents the new release flow
  • CLAUDE.mdAGENTS.md — renamed with updated workflow instructions
  • bin/release.sh — removed (replaced by automated workflow)

Setup required

Add these repository secrets for the SVN deploy:

  • SVN_USERNAME — WordPress.org username
  • SVN_PASSWORD — WordPress.org password

Test plan

  • Open a test PR to verify the changelog workflow runs and enforces entries
  • Verify "Skip Changelog" label bypasses the check
  • Test bin/changelog-add.sh locally to create an entry
  • Test bin/changelog-write.sh <version> locally to verify output format matches existing CHANGELOG.md
  • After adding secrets, test with a draft/pre-release to verify the deploy workflow

- Per-PR changelog entries in .github/changelog/unreleased/
- GitHub Action enforces changelog on PRs (with auto-create from PR description)
- Automated deploy to WordPress.org on GitHub release via 10up action
- Deploy workflow handles version bump, changelog compilation, and SVN push
- Rename CLAUDE.md to AGENTS.md with updated workflow docs
- Remove bin/release.sh, add bin/version-bump.sh and bin/changelog-write.sh
@github-actions

github-actions Bot commented Mar 29, 2026

Copy link
Copy Markdown
Contributor

Test this PR in WordPress Playground

You can test this pull request directly in WordPress Playground:

Launch WordPress Playground

This will install and activate the plugin with the changes from this PR.

@akirk akirk merged commit 1893bf3 into main Apr 1, 2026
25 checks passed
@akirk akirk deleted the feature/changelog-and-deploy branch April 1, 2026 12:37
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