/github-updater-additions

Add repositories to GitHub Updater that lack actual GitHub Updater headers.

Primary LanguagePHPGNU General Public License v2.0GPL-2.0

GitHub Updater Additions

A plugin that allows for adding installed plugins or themes hosted on GitHub, Bitbucket, GitLab, or Gitea that do not contain required headers to GitHub Updater.

Description

This is a plugin that will add the appropriate data via hooks in GitHub Updater so that repositories that are not correctly configured to use GitHub Updater may be added to GitHub Updater without modifying the repository. This only works for installed plugins/themes.

A properly configured JSON file must reside in the root directory of this plugin.

Installation

Adapt the github-updater-additions.json file to your needs.

JSON config file format

This file must be named github-updater-additions.json.

[
  {
    "type": "github_plugin",
    "slug": "plugin-noheader/plugin-noheader.php",
    "uri": "https://github.com/afragen/plugin-noheader"
  },
  {
    "type": "bitbucket_theme",
    "slug": "theme-noheader",
    "uri": "https://bitbucket.org/afragen/theme-noheader"
  }
]

The "type" element is from the following list.

  • github_plugin
  • github_theme
  • bitbucket_plugin
  • bitbucket_theme
  • gitlab_plugin
  • gitlab_theme
  • gitea_plugin
  • gitea_theme

The "slug" element is either the plugin slug or the theme stylesheet slug.

The "uri" element should be self-explanatory.

Development

PRs are welcome against the develop branch.