Github to WordPress.org deploy script

Today I polished, documented, and open sourced a bash script I’ve been using to do plugin deployments from Github to WordPress.org (plus I wanted an excuse to use the new WordPress.com desktop app which is awesome by the way). It’s based on code Barry Kooij sent me a while back. You can find it here:

https://github.com/mikejolley/github-to-wordpress-deploy-script

It handles Github tagging, removing junk files, and SVN tagging with minimal effort. It also has a quick checklist to stop you forgetting to set things in the readme.txt like the stable version (I’ve been guilty of forgetting this in the past).

Once downloaded to your machine, the script requires a Github access token, and a few edits to tell it which plugin you’re deploying.

After you’ve added the details specific to your project, you simply need to open it’s parent directory in terminal, and run the command:

sh release.sh

It then prompts you for a version, branch, and handles the deployment process.

demo

The above demo is from a release of WP Job Manager I did today showing it working nicely. Hope it’s useful!


Posted

in

by

Tags:

Comments

15 responses to “Github to WordPress.org deploy script”

    1. Mike Jolley avatar

      I’ve used it in the past but had some troubles when releasing WC. I cannot quite remember what went wrong…

  1. Phil avatar

    Great stuff! I’ve actually been working on something just like this this week.

    Any particular reason for using the GH API to tag the release, rather than just ‘git tag’?

    1. Mike Jolley avatar

      This creates a ‘release’ on Github, git tag just creates a ‘tag’.

      1. Phil avatar

        And all the time there was me thinking they were the same thing…

  2. Caspar Hübinger avatar

    Thank you, Mike, this is a great helper! One question: How do you handle updates for a plugin’s “assets” directory on w.org? I understand once screenshots, banners, and icon images have been committed once, they rarely need to be updated; just asking out of curiosity. The script doesn’t handle assets in the sense of w.org, does it? Would you just edit the script when you need to add a screenshot to a repo?

    1. Mike Jolley avatar

      This is usually a ‘one off’ so I just use SVN/Versions app to upload these. I don’t think a release script is necessary.

      1. Caspar Hübinger avatar

        Agreed. Thanks again, great tool.

  3. Sunny (@tha_sun) avatar

    Have you tried https://github.com/sun/wordpress-git-svn-release and siblings? They have a long history and seemingly look very similar – did you have a particular reason for creating a new one from scratch?

    1. Mike Jolley avatar

      Some, but I have specific needs. Releases not tags, and the branch of my choice.

  4. mathetos avatar

    HI Mike, need to kick the tires on this. I’m curious if it can push from a Git branch to an SVN tag? Basically, I want to push to a tag so that the plugin is NOT updated live. Thanks!

    1. Mike Jolley avatar

      You’d need to tweak the code which copies the files into the SVN directory trunk. Certainly possible if you customise it 🙂

    2. Ahmad Awais avatar

      Matt, that’s what I was looking into. I think I’ll fork and modify it. It’s pretty easy. Thanks to all the contributors.

  5. Ahmad Awais avatar

    Just used it, worked pretty great. Going to fork it and work on it a little. I am working on my bash scripting skills.
    Thanks for the cool script though.

  6. Pippinsplugins (@pippinsplugins) avatar

    This is wonderful. Thank you!