Create release steps

Ben Goldsworthy 2021-03-01 20:40:46 +00:00
parent ac5fafe82a
commit b9b884be54

19
SVN-Release-Guide.md Normal file

@ -0,0 +1,19 @@
This is a quick guide for releasing new versions of the Plugin to the [WP Plugin Directory Subversion repo](https://github.com/markcheret/footnotes/issues/30). It is designed to supplement, but not replace, the information in the [WP Plugin Developer Handbook](https://developer.wordpress.org/plugins/wordpress-org/how-to-use-subversion/).
# 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.
# Pushing Code to the WP Plugin Directory
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** (but do update the two version numbers in `trunk/footnotes.php` to <next-version-number>d<dev-version-number> — see here for more info
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 "<your message>"`)
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` and the WP Plugin Directory will automatically handle the release.