afragen/git-updater-lite

A simple class to integrate with Git Updater for standalone plugin/theme updates.

Maintainers

Details

github.com/afragen/git-updater-lite

Source

Issues

Installs: 42

Dependents: 0

Suggesters: 0

Security: 0

Stars: 12

Watchers: 1

Forks: 1

Open Issues: 0

1.1.0 2024-12-18 06:58 UTC

Requires

  • php: >=8.0

MIT 3399a536bd4113432f9ce61116c53aa80fc59110

pluginthemewordpressupdater

This package is auto-updated.

Last update: 2024-12-18 06:58:23 UTC

README

A simple standalone library to enable automatic updates to your git hosted WordPress plugins or themes.

Description

This library was designed to be added to your git hosted plugin or theme to enable standalone updates.

You must have a publicly reachable site that will be used for dynamically retrieving the update API data.

  • Git Updater is required on a site where all of the release versions of your plugins and themes are installed.
  • All of your plugins/themes must be integrated with Git Updater.
  • You must be using Git Updater v12.7.0 or better.

Git Updater is capable of returning a REST endpoint containing the plugins_api() or themes_api() data for your plugin/theme. You will pass this endpoint during the integration.

The REST endpoint format is as follows.

  • plugins - https://my-site.com/wp-json/git-updater/v1/plugins-api/?slug=my-plugin
  • themes - https://my-site.com/wp-json/git-updater/v1/themes-api/?slug=my-theme

Installation

Add via composer. composer require afragen/git-updater-lite:^1

Add the following to your plugin or theme where <URI> is the REST endpoint.

require_once __DIR__ . '/vendor/afragen/git-updater-lite/Lite.php';
( new \Fragen\Git_Updater\Lite( __FILE__ ) )->run('<URI>');

An example integrated plugin is here, https://github.com/afragen/test-plugin-gu-lite

FWIW, I test by decreasing the version number locally to see an update.