miya/gh-auto-updater

Automatic Updater with GitHub API for WordPress Plugin

, _(*1)

A composer library for self-hosted WordPress plugin on GitHub with automatic update., _(*2)

Getting Started

1. The easier way to install this is by using composer.

$ composer require miya/gh-auto-updater

2. Activate automatic update in your WordPress plugin.

<?php

// Autoload
require_once( dirname( __FILE__ ) . '/vendor/autoload.php' );

add_action( 'init', 'activate_autoupdate' );

function activate_autoupdate() {
    $plugin_slug = plugin_basename( __FILE__ ); // e.g. `hello/hello.php`.
    $gh_user = 'miya0001';                      // The user name of GitHub.
    $gh_repo = 'gh-auto-updater-example';       // The repository name of your plugin.

    // Activate automatic update.
    new Miya\WP\GH_Auto_Updater( $plugin_slug, $gh_user, $gh_repo );
}

3. GitHub Access Token (Optional)

You can use personal access token., _(*3)

define( 'GITHUB_ACCESS_TOKEN', 'xxxxxxxx' );

How to update your plugin.

To release the new version, please do as follows:, _(*4)

1. Tag and push to GitHub.

$ git tag 1.1.0
$ git push origin 1.1.0

• 1.0.0 is a version number, it have to be same with version number in your WordPress plugin.
• You have to commit vendor directory in your plugin.

2. Release the new version.

1. Please visit "releases" in your GitHub repository.
2. Choose a tag.
3. Fill out the release note and title.
4. Upload your plugin which is comporessed with zip. (Optional)
5. Press "Publish release".

Also, you can use automatic release., _(*5)

Following is an example of the .travis.yml for automatic release., _(*6)

https://github.com/miya0001/miya-gallery/blob/master/.travis.yml, _(*7)

You can generate deploy: section by The Travis Client like following., _(*8)

$ travis setup releases

Example Projects

Please install old version of following projects, then you can see update notice., _(*9)

• https://github.com/miya0001/self-hosted-wordpress-plugin-on-github
• https://github.com/miya0001/miya-gallery

These projects deploy new releases automatically with Travis CI., _(*10)

$ travis setup releases

Please check .travis.yml and documentation., _(*11)

Screenshots

Notification on "Plugins" screen in WordPress dashboard., _(*12)

, _(*13)

"Details" screen in WordPress dashboard. You can see release note on GitHub as changelog., _(*14)

, _(*15)

"WordPress Updates" screen., _(*16)

, _(*17)

License

GPL v2, _(*18)