Skip to content
A REST API based remote updater for GitHub Updater
PHP JavaScript
Branch: develop
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets
js
languages
src/Git_Remote_Updater
vendor
.gitattributes
.gitignore
CHANGES.md
LICENSE
README.md
composer.json
composer.lock
git-remote-updater.php
readme.txt

README.md

Git Remote Updater

Description

Allows you to easily update GitHub Updater repositories in bulk via REST API endpoint updating.

The Git Remote Updater page allows updating via repository or site.

Setup

Requires GitHub Updater v.9.0.0 or higher running on the sites you use with Git Remote Updater.

You can obtain the needed data from your GitHub Updater > Remote Management tab and then copy it into the Settings > Add Site form. You will only need to update data if your REST API key changes.

Git Remote Updater Settings

Update feedback will show at the top of the page. If you have debug logging set on your site, it is also added to the debug.log.

I recommend running Git Remote Updater from a local development environment installation of WordPress, though you can run it from any WordPress site.

Usage

By using the Site URL and the REST API key you can add sites to the Settings page.

Settings

Once you have site data added, the Update page will present options for you to update repositories.

You can update individual repositories across all the sites the repositories exist on.

Update individual repos

Or you can update all the repositories on an individual site all at once.

Update whole site

The update process will continue until it succeeds. Feedback is presented at the top of the page when the process has completed. Feedback will also be added the the site's debug.log, if debug logging is set for the site.

Update Feedback

If there is a timeout error in the update process, Git Remote Upater will continue to attempt updating until it succeeds.

Other errors will not attempt to retry the update an will display the appropriate error.

Any site that is unreachable will not display any repository data in the Update page.

Filters and Hooks

If you have specific repositories that you wish to exclude you can add them using the filter hook as follows.

add_filter(
	'git_remote_updater_remove_site_data',
	function() {
		return [ 'caldera-forms', 'github-updater' ];
	}
);

If you wish to modify the transient timeout for repo data; return the number of seconds, as an integer, to the following filter. Default is 600 seconds. Less is better for testing.

add_filter(
	'git_remote_updater_repo_transient_timeout',
	function() {
		return 5;
	}
);

PRs are welcome against the develop branch.

You can’t perform that action at this time.