From 88a7b47813c6e146177fbca199df55ee043d982f Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Thu, 18 Mar 2021 22:49:48 +0000 Subject: [PATCH] Update for release helper --- SVN-Release-Guide.md | 25 +++++++++++-------------- 1 file changed, 11 insertions(+), 14 deletions(-) diff --git a/SVN-Release-Guide.md b/SVN-Release-Guide.md index 9806b35..847df95 100644 --- a/SVN-Release-Guide.md +++ b/SVN-Release-Guide.md @@ -6,19 +6,16 @@ Version control with SVN is different to Git. Each SVN revision includes a snaps Subversion is for release control, not development. This Git repo, hosted on GitHub, is for development. -# Pushing Code to the WP Plugin Directory +# How to Make a New Release -1. Copy the SVN repo. locally (`svn co https://plugins.svn.wordpress.org/footnotes/ footnotes-svn`); -1. Enter the folder (`cd footnotes-svn`); -1. Copy over the files from your local copy of this repo. (**make sure you have checked out the `main` branch**) into the `trunk/` directory; - 1. **MAKE SURE THAT THE ‘Stable Tag’ FIELD IN `trunk/readme.txt` IS THE LATEST RELEASE VERSION, NOT DEVELOPMENT!** -1. View the changes (`svn stat`); -1. If you are adding/removing any files, make sure you add them to/remove them from tracking using `svn add`/`svn rm` -1. Commit your changes (`svn ci -m ""`); -1. Pull down another copy of the repo. to test locally; -1. When the new version is ready for release, update the ‘Stable Tag’ field in `trunk/readme.txt`; -1. Make sure the version number in trunk/footnotes.php is now in sync with the Stable Tag version; -1. Copy trunk/ to its tagged folder: `svn cp trunk tags/`; -1. Commit the release: `svn ci -m $''` +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 WP Plugin Directory will automatically handle the release. \ No newline at end of file +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/`); and +5. commit your changes (`svn ci -m "Release version "`). + +The WP Plugin Directory will automatically parse the ‘Stable Tag’ field in `trunk/readme.txt`, and inform users that a new version is available. \ No newline at end of file