SVN Release Guide

This is a quick guide for releasing new versions of the Plugin to the WP Plugin Directory Subversion repo. It is designed to supplement, but not replace, the information in the WP Plugin Developer Handbook.

SVN Quick Facts

Version control with SVN is different to Git. Each SVN revision includes a snapshot of the entire codebase, rather than Git where only edited files are included in a commit.

Subversion is for release control, not development. This Git repo, hosted on GitHub, is for development.

How to Make a New Release

When we're ready to create a new pre-release, whoever has been designated to do so just has to run the command composer run release (to test) or composer run release:commit (to push the pre-release version to the remote SVN repo.).

The pre-release (or 'p') codebase will then go through a period of testing, and when we're happy with it, someone will be designated to push the release by following these steps:

1. update the ‘Stable Tag’ field in the local copy of trunk/readme.txt to the new version;
2. update the ‘Version’ field in the comment header of the local trunk/footnotes.php to the new version;
3. remove the ‘p’ from the end of the ‘version’ tag in the getInfo() function at the bottom of the local js/wsiwyg-editor.js;
4. copy a new tag for the release from the local trunk/ (svn cp trunk tags/<version number>); and
5. commit your changes (svn ci -m "Release version <version number>").

The WP Plugin Directory will automatically parse the ‘Stable Tag’ field in trunk/readme.txt, and inform users that a new version is available.