Conversation
…y; update features, requirements, and usage examples; add manual build workflow and improve release zip verification
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces a major refactor and modernization of the WordPress GitHub plugin updater, focusing on a clearer API, improved documentation, and robust workflow automation. The most significant changes are the introduction of a canonical static API (
GitHubUpdater::init), a streamlined and more informativeREADME.md, enhanced error handling, and improved GitHub Actions workflows for building release assets.Key changes include:
API Modernization & Code Refactor
GitHubUpdaterclass with a staticinitmethod as the canonical API for plugin update registration, deferring initialization safely to the WordPressinithook and improving error handling and type safety. The legacyGitHub_Plugin_Updateris now a wrapper for backward compatibility. (class-github-plugin-updater.php)class-github-plugin-updater.php)ABSPATH. (class-github-plugin-updater.php)Documentation Overhaul
README.mdfor clarity: emphasizes the new static API, provides concise setup instructions, details requirements and troubleshooting, and documents workflow integration for release assets. Also clarifies backward compatibility and best practices. (README.md)Workflow Improvements
on-release-add.zip.yml) to use a parameterized plugin zip name, optimized Composer install, and added a verification step to ensure the required dependency is included in the zip. (on-release-add.zip.yml)manually-build-zip.yml) for building and releasing plugin zips on demand for a specific tag, mirroring the improvements in the release workflow. (manually-build-zip.yml)