Merge for v3.1.0 (#43)

* Docs: Refresh README

* Docs: Tweak the process / steps list

* Avoid error if xargs is empty

* Revert "Avoid error if xargs is empty"

This reverts commit b2fb8d3.

* resolve inconsistencies

* more specific

* updated to use `svn resolve`, not needed in tags directory

* add reading of local .svnignore over defaults

* fix typo

* use $SVNIGNORE for svn del

svn propset snv:ignore ... is flaky

* make as comment and reorder

* rename ignore file

* use `xargs rm -rf` as `xargs svn del`

will exit early if file doesn't exist

* use .svnignore

* me

* initial dupicate of deploy.sh

* update readme

* remove

* reset user

* Update readme.txt to latest tag (#39)

* update readme

* initial pass at readme only update


update


silence

* update readme.txt if current tag already exists

Co-authored-by: Gary Jones <[email protected]>
Co-authored-by: Stefano Saitta <[email protected]>

Author: 3 people

README.md

@@ -1,27 +1,31 @@
-# Github to WordPress Plugin Directory Deployment Script, Git-Flow Version
+# WordPress Plugin Directory Deployment Script
 
-Deploys a WordPress plugin from Github (git) to the WordPress Plugin Repostiory (svn), taking account of standard [git-flow](https://github.com/nvie/gitflow) usage.
+Deploys a WordPress plugin from a local Git repo to the WordPress Plugin Repostiory (SVN).
 
-## Credits
-Well over 90% of this script was written by others:
+## Steps
 
- - **[Dean Clatworthy](https://twitter.com/deanclatworthy)** - [Original script](https://github.com/deanc/wordpress-plugin-git-svn)
- - **[Brent Shepherd](https://twitter.com/thenbrent)** - [Avoids permanent local SVN repo, avoids sending redundant stuff to WP repo](http://thereforei.am/2011/04/21/git-to-svn-automated-wordpress-plugin-deployment/)
- - **[Patrick Rauland](https://twitter.com/BFTrick)** - [Support for WP assets folder for plugin page banner and screenshots](https://github.com/BFTrick/jotform-integration/blob/master/deploy.sh)
- - **[Ben Balter](https://twitter.com/benbalter)** - [Submodules support and plugin slug prompt](https://github.com/benbalter/Github-to-WordPress-Plugin-Directory-Deployment-Script/)
- - **[Gary Jones](https://twitter.com/GaryJ)** *(me)* - [Personalisation and commenting out bits not required when using git-flow](https://github.com/GaryJones/wordpress-plugin-git-flow-svn-deploy) 
- 
-## Process
- 1. Prompts for plugin slug and other data.
- - Verifies plugin header version number matches readme stable version number or readme stable version is trunk
- - Pushes latest git commit and tags to GitHub.
- - Creates temporary checkout of SVN repo.
- - Ignores non-WordPress repo files from SVN.
- - Copies git export to SVN trunk.
- - Checks out any submodules.
- - Copies contents of assets directory in trunk to a directory parallel to trunk.
- - Commits SVN trunk, assets and tag.
- - Attempts to remove temporary SVN checkout.
+These are the steps that the script takes:
+
+ 1. Asks for plugin slug.
+ 2. Asks for local plugin directory.
+ 3. Checks local plugin directory exists.
+ 4. Asks for main plugin file name.
+ 5. Checks main plugin file exists.
+ 6. Checks `readme.txt` version matches main plugin file version.
+ 7. Asks for temporary SVN checkout path.
+ 8. Asks for remote SVN repo URL.
+ 9. Asks for SVN username.
+ 10. Asks if input is correct, and gives chance to abort.
+ 11. Checks if Git tag exists for version number (must match exactly).
+ 12. Does checkout of SVN repo.
+ 13. Sets SVN ignore on some GitHub-related files.
+ 14. Exports `HEAD` of `master` from Git to the trunk of SVN.
+ 15. Initialises and updates any git submodules.
+ 16. Moves `/trunk/assets` up to `/assets`.
+ 17. Moves into `/trunk`, and does an SVN commit.
+ 18. Moves into `/assets`, and does an SVN commit.
+ 19. Copies `/trunk` into `/tags/{version}`, and does an SVN commit.
+ 20. Deletes temporary local SVN checkout.
 
 ## Install
 
@@ -30,9 +34,29 @@ Well over 90% of this script was written by others:
 3. Run the script with `sh deploy.sh`. You can also double-click it in Finder / Explorer to start it.
 4. You'll now be guided through a set of questions.
 
-With [git-flow](https://github.com/nvie/gitflow), specifically the `git flow release finish ...` command, the release branch is merged into the develop branch, the master branch and a tag is created, so these aren't needed with this deploy script.
- 
 I prefer to keep this script in the root of my projects directory. Each project directory is named as the plugin slug, as is the corresponding GitHub repo. To use, just call the script, enter the plugin slug, confirm or amend default suggestions, and sit back as the code is sent to SVN and git repos including tags. The commit messages here are hard-coded for consistency.
 
+## Extras
+
+You may define your own `.svnignore` file similar to an `svn propset svn:ignore .svnignore` command. This will remove any listed files and/or directories from committing to the Plugins Directory.
+
+NB: you must list files separately, no wildcards.
+
+Reference: https://stackoverflow.com/questions/17298668/svn-ignore-like-gitignore
+
+## Credits
+
+At one point, well over 90% of this script was written by others:
+
+ - **[Dean Clatworthy](https://twitter.com/deanclatworthy)** - [Original script](https://github.com/deanc/wordpress-plugin-git-svn)
+ - **[Brent Shepherd](https://twitter.com/thenbrent)** - [Avoids permanent local SVN repo, avoids sending redundant stuff to WP repo](http://thereforei.am/2011/04/21/git-to-svn-automated-wordpress-plugin-deployment/)
+ - **[Patrick Rauland](https://twitter.com/BFTrick)** - [Support for WP assets folder for plugin page banner and screenshots](https://github.com/BFTrick/jotform-integration/blob/master/deploy.sh)
+ - **[Ben Balter](https://twitter.com/benbalter)** - [Submodules support and plugin slug prompt](https://github.com/benbalter/Github-to-WordPress-Plugin-Directory-Deployment-Script/)
+ - **[Gary Jones](https://twitter.com/GaryJ)** *(me)* - [Personalisation and commenting out bits not required when using git-flow](https://github.com/GaryJones/wordpress-plugin-git-flow-svn-deploy)
+
+ There has been a significant amount of changes since then though.
+
+
 ## License
+
 This package was created at a time when the above credited repositories had no license. For any amendements done since then, the code is [licensed](LICENSE.md) under MIT. For the original work, contact the previous authors.

deploy.sh

@@ -25,7 +25,7 @@
 # 20. Delete temporary local SVN checkout.
 
 echo
-echo "WordPress Plugin SVN Deploy v3.0.0"
+echo "WordPress Plugin SVN Deploy v3.1.0"
 echo
 echo "Let's collect some information first. There are six questions."
 echo
@@ -155,14 +155,25 @@ echo
 echo "Creating local copy of SVN repo trunk..."
 svn checkout $SVNURL $SVNPATH --depth immediates
 svn update --quiet $SVNPATH/trunk --set-depth infinity
+svn update --quiet $SVNPATH/tags/$PLUGINVERSION --set-depth infinity
 
 echo "Ignoring GitHub specific files"
-svn propset svn:ignore "README.md
+# Use local .svnignore if present
+if [ -f ".svnignore" ]; then
+	echo "Using local .svnignore"
+	SVNIGNORE=$( <.svnignore )
+else
+	echo "Using default .svnignore"
+	SVNIGNORE="README.md
 Thumbs.db
-.github/*
+.github
 .git
 .gitattributes
-.gitignore" "$SVNPATH/trunk/"
+.gitignore
+composer.lock"
+fi
+
+svn propset svn:ignore \""$SVNIGNORE"\" "$SVNPATH/trunk/"
 
 echo "Exporting the HEAD of master from git to the trunk of SVN"
 git checkout-index -a -f --prefix=$SVNPATH/trunk/
@@ -201,6 +212,8 @@ echo
 echo "Changing directory to SVN and committing to trunk."
 cd $SVNPATH/trunk/
 # Delete all files that should not now be added.
+# Use $SVNIGNORE for `rm -rf`. Setting propset svn:ignore seems flaky.
+echo "$SVNIGNORE" | awk '{print $0}' | xargs rm -rf
 svn status | grep -v "^.[ \t]*\..*" | grep "^\!" | awk '{print $2"@"}' | xargs svn del
 # Add all new files that are not set to be ignored
 svn status | grep -v "^.[ \t]*\..*" | grep "^?" | awk '{print $2"@"}' | xargs svn add
@@ -215,17 +228,25 @@ svn status | grep -v "^.[ \t]*\..*" | grep "^\!" | awk '{print $2"@"}' | xargs s
 # Add all new files that are not set to be ignored
 svn status | grep -v "^.[ \t]*\..*" | grep "^?" | awk '{print $2"@"}' | xargs svn add
 svn update --quiet --accept working $SVNPATH/assets/*
+svn resolve --accept working $SVNPATH/assets/*
 svn commit --username=$SVNUSER -m "Updating assets"
 
 echo
 
 echo "Creating new SVN tag and committing it."
 cd $SVNPATH
+# If current tag not empty then update readme.txt
+if [ -n "$(ls -A tags/$PLUGINVERSION 2>/dev/null)" ]; then
+	echo "Updating readme.txt to tag $PLUGINVERSION"
+	svn delete --force tags/$PLUGINVERSION/readme.txt
+	svn copy trunk/readme.txt tags/$PLUGINVERSION
+fi
 svn copy --quiet trunk/ tags/$PLUGINVERSION/
 # Remove assets and trunk directories from tag directory
 svn delete --force --quiet $SVNPATH/tags/$PLUGINVERSION/assets
 svn delete --force --quiet $SVNPATH/tags/$PLUGINVERSION/trunk
 svn update --quiet --accept working $SVNPATH/tags/$PLUGINVERSION
+#svn resolve --accept working $SVNPATH/tags/$PLUGINVERSION/*
 cd $SVNPATH/tags/$PLUGINVERSION
 svn commit --username=$SVNUSER -m "Tagging version $PLUGINVERSION"