To release the Pro plugin, ensure you complete all the tasks below.
Pre-release Checklist
[x] Create the release branch as release-<version> from the development branch.
[x] Review and merge all relevant Pull Requests into the release branch.
[x] Update the version number to a beta version in the main plugin file as per tech documentation, and commit to the release branch.
[x] Verify the correct version of the free plugin is referenced in the lib/composer.json file. Prefer stable versions.
[x] Start a dev-workspace session.
[x] Run composer update (updating root and lib vendors).
[x] Review updated packages and mention any production library updates in the changelog.
[x] Check if all dependencies are synced from Free into the Pro plugin with composer check:deps. If required, merge dependencies using composer fix:deps and run composer update again.
[x] Check if the free plugin uses Composer's autoload and copy the autoload definition from the free plugin to the pro plugin refactoring the relative paths, on /lib/composer.json. Execute composer dumpautoload to update the autoload files. Commit the changes.
[x] Inspect GitHub’s Dependabot warnings or Pull Requests. Resolve any false positives, then fix and commit the remaining issues.
[x] If needed, build JS files for production using composer build:js and commit changes.
[x] Run a code quality check with composer check and fix the highlighted issues.
[x] Update the language files with composer gen:lang and note this in the changelog.
[x] For minor and patch releases, maintain backward compatibility (e.g., renamed or moved classes, namespaces, functions). Include deprecation comments and note this in the changelog. Major releases may remove deprecated code; always note this in the changelog.
[x] Update the changelog in /CHANGELOG.md with a user-friendly description and correct release date.
[x] Update the changelog in readme.txt, maintaining records of the last 4-5 releases only.
[x] Confirm there are no uncommitted changes.
[x] Build the zip package with composer build, creating a new beta package in the ./dist directory.
[x] Distribute the new package to the team for testing.
Release Checklist
[x] Update the version number to a stable version in the main plugin file and readme.txt as per tech documentation, and commit to the release branch.
[x] If anything changed in the code after test package distribution, redo the pre-release checklist.
[x] Build the final zip package with composer build, creating a new package in the ./dist directory.
[x] Create and merge a Pull Request for the release branch into the main branch.
[ ] Merge the main branch into the development branch.
[ ] Establish the GitHub release on the main branch with the correct tag.
PublishPress.com Deployment
[ ] Update the EDD registry on the Downloads menu, uploading the new package and updating the changelog.
[ ] Perform a final test by updating the plugin on a staging site.
To release the Pro plugin, ensure you complete all the tasks below.
Pre-release Checklist
release-<version>
from the development branch.lib/composer.json
file. Prefer stable versions.composer update
(updating root and lib vendors).composer check:deps
. If required, merge dependencies usingcomposer fix:deps
and runcomposer update
again./lib/composer.json
. Executecomposer dumpautoload
to update the autoload files. Commit the changes.composer build:js
and commit changes.composer check
and fix the highlighted issues.composer gen:lang
and note this in the changelog./CHANGELOG.md
with a user-friendly description and correct release date.readme.txt
, maintaining records of the last 4-5 releases only.composer build
, creating a new beta package in the./dist
directory.Release Checklist
readme.txt
as per tech documentation, and commit to the release branch.composer build
, creating a new package in the./dist
directory.main
branch.main
branch into thedevelopment
branch.main
branch with the correct tag.PublishPress.com Deployment