README

这是一个用于GitHub上自托管WordPress插件的Composer库，支持自动更新。

入门指南

1. 使用Composer安装是最简单的方法。

$ composer require miya/gh-auto-updater

2. 在您的WordPress插件中激活自动更新。

<?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访问令牌（可选）

您可以使用个人访问令牌。

define( 'GITHUB_ACCESS_TOKEN', 'xxxxxxxx' );

如何更新您的插件。

要发布新版本，请按照以下步骤操作

1. 标记并推送到GitHub。

$ git tag 1.1.0
$ git push origin 1.1.0

1.0.0 是版本号，它必须与WordPress插件中的版本号相同。
您必须提交插件中的 vendor 目录。

2. 发布新版本。

请访问GitHub仓库中的“发布”。
选择一个标记。
填写发布说明和标题。
上传压缩为zip格式的插件。（可选）
点击“发布发布”。

此外，您还可以使用自动发布。

以下是一个自动发布的 .travis.yml 示例。

https://github.com/miya0001/miya-gallery/blob/master/.travis.yml

您可以通过Travis客户端生成以下示例。

$ travis setup releases

示例项目

请安装以下项目的旧版本，然后您可以看到更新通知。

这些项目使用Travis CI自动部署新版本。

$ travis setup releases

请检查 .travis.yml 和文档。

屏幕截图

WordPress仪表板“插件”屏幕上的通知。

WordPress仪表板“详细信息”屏幕。您可以在GitHub上作为变更日志看到发布说明。

“WordPress更新”屏幕。

许可证

GPL v2

miya / gh-auto-updater

维护者

详细信息