Self Hosted Plugin updates
This is a bare minimum plugin example for a theme to use the WP Stockroom updater.
by wpstockroom · github.com/wpstockroom/wp-stockroom-sample-plugin
★ 0stars
0forks
Install
No release zip yet. The repository archive installs, but the folder name will carry the branch suffix and updates will not flow:
wp plugin install https://github.com/wpstockroom/wp-stockroom-sample-plugin/archive/refs/heads/main.zipDeclares an update source (wpstockroom.com), so updates arrive through the plugin's own updater.
From the readme
WP Stockroom Sample Plugin
This is a bare minimum plugin example for a plugin to use the WP Stockroom updater.
Required files
- readme.txt
- Only the Stable tag is required.
- Here is the documentation of the readme file.
- class-wp-stockroom-updater.php
The Main stockroom updater script. It has to be included in some way.
- MAINP-PLUGIN-FILE.php
- The Plugin Name The plugin name
- The Update URI Should be set to your own hosted stockroom installation.
This should be your domain without https:// and no trailing slash.
- The Version Is required.
- Here is a list of all (optional) plugin headers.
- Includes the class-wp-stockroom-updater.php script.
- Then registers the updater.
- .github/workflows/deployment.yml
The Github action that triggers when creating a new version. See the Github action repository for details.
- .distignore
What files to exclude form the build plugin.zip file. Technically not needed, strongly recommended.
Registering the updater
Releasing a new version
When you are ready to release a new version. Do the following steps.
- Update the "Version" header in your MAINP-PLUGIN-FILE.php.
- Update the "Stab
Read the full README on GitHub →
Releases
These releases are tags only. The author does not attach a packaged zip, so there are no download counts to report.