README

Provides the ability to update a wordpress plugin using Github instead of wordpress.

Installation & Usage

Add composer package to your plugin

composer require umdigital/wordpress-github-updater

Update Plugin Header

Add the following to your plugins header

Update URI: https://github.com/GITHUB_ACCOUNT/GITHUB_REPO

Initialize the library

include 'vendor/umdigital/wordpress-github-updater/github-updater.php';

// Initialize Github Updater
new \Umich\GithubUpdater\Init([
    'repo' => 'its-cloudflare/umich-cloudflare',
    'slug' => plugin_basename( __FILE__ ),
]);

Create / Update your build process

For best support it is recommended to add a release workflow that will automatically package the plugin into a wordpress compatible zip file. The default github source archives cause irregular plugin folder naming during install and updates. There are some options of workflows in the examples directory. These workflows will create a release when a tag is pushed to the repo. The one with composer in the name will also add composer dependencies to the package. This will create a release asset in the format of [REPO_NAME]-[TAG_NAME].zip.

Configuration

Initialization Options

Config File (wordpress.json) Options