WordPress Plugin Install with GitHub Updates

You are probably used to the way you install and update plugins and themes via the WordPress.org repo.  However, sometimes nerds like us at JDM Digital want another way to do it.

If the plugin is something we’re still actively working on and you want to install it on your site, we recommend you use the following process to install and update your non-wordpress.org hosted JDM plugins.

Install GitHub Updater

First off, you’ll need to install a snazzy plugin called GitHub Updater.  It’s not allowed on the WordPress.org repo (not surprisingly), so you have to install it manually.  Here’s how.

1. Download the latest tagged archive (choose the “zip” option).
2. Unzip the archive, rename the folder to github-upddater.
3. Copy the folder to your /wp-content/plugins/ directory and upload.
4. Go to the Plugins screen and click Activate.

Once activated, head over to Settings >> GitHub Updater to finish the setup.

You’ll need to enter a GitHub Access Token.  Getting one is easy.  Here’s how.

Install a JDM Digital Plugin Using GitHub Updater

Now that’s all done, you’re ready to install a non-wordpress.org hosted JDM Digital plugin using the GitHub Updater.

1. Go to Settings >> GitHub Updater
2. Click the Install Plugin tab
3. Enter the GitHub Repo URL for our plugin, something like: https://github.com/jdmdigital/{repo name}
4. Leave the Branch blank (we want it to default to “master”)
5. Make sure the Remote host is set to “GitHub”
6. Click the Install Plugin button
7. Click the Back to Plugins Page link after it’s installed
8. Click the Activate link below the newly installed plugin.

That’s it.  You’re done.

As new versions are released (pull requests merged into the Master branch), you’ll receive the normal WordPress Plugin update notice.  All you (should) have to do is click Update.

Pretty snazzy, right?!