Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/afragen/git-remote-updater
A REST API based remote updater for GitHub Updater
https://github.com/afragen/git-remote-updater
plugin remote-update theme wordpress
Last synced: 8 days ago
JSON representation
A REST API based remote updater for GitHub Updater
- Host: GitHub
- URL: https://github.com/afragen/git-remote-updater
- Owner: afragen
- License: mit
- Created: 2019-09-26T03:34:26.000Z (about 5 years ago)
- Default Branch: develop
- Last Pushed: 2024-08-29T18:02:44.000Z (3 months ago)
- Last Synced: 2024-11-02T10:33:18.473Z (15 days ago)
- Topics: plugin, remote-update, theme, wordpress
- Language: PHP
- Homepage:
- Size: 2.58 MB
- Stars: 8
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Git Remote Updater
* Author: Andy Fragen
* Author URI: https://github.com/afragen
* Donate link: https://thefragens.com/git-updater-donate
* License: MIT
* Requires PHP: 7.2
* Requires at least: 5.9
## Description
Allows you to easily update Git Updater repositories in bulk via [REST API endpoint updating](https://github.com/afragen/git-updater/wiki/Remote-Management---RESTful-Endpoints).
The **Git Remote Updater** page allows updating via repository or site.
## Setup
Requires [Git Updater](https://github.com/afragen/git-updater) v12.0.0 or higher and an active license running on the sites you use with Git Remote Updater.
You can obtain the needed data from your `Git 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.
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.
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.
Or you can update all the repositories on an individual site all at once.
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.
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.
```php
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.
```php
add_filter(
'git_remote_updater_repo_transient_timeout',
function() {
return 5;
}
);
```
PRs are welcome against the `develop` branch.