Automatic updates via GitHub releases #2
Merged
Conversation
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
- Introduced a new file `PucReadmeParser.php` in the vendor directory of the yahnis-elsts/plugin-update-checker package. - The `PucReadmeParser` class is designed to parse WordPress plugin readme files, providing structured access to metadata such as plugin name, description, installation instructions, FAQs, changelog, and more. - The parser utilizes Parsedown for Markdown processing, replacing the previous "Markdown Extra" parser. - Key functionalities include: - Reading and sanitizing the readme file content. - Extracting essential fields like plugin name, required PHP version, stable tag, tags, contributors, and donation link. - Handling special sections like description, installation, FAQs, screenshots, and changelog. - Supporting short descriptions and managing content truncation. - Implementing a robust filtering mechanism to ensure safe HTML output. - This addition enhances the plugin update checker functionality by allowing it to read and interpret plugin metadata directly from the readme files, improving the overall update experience.
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 automatic update support for the plugin by integrating the Plugin Update Checker library, enabling seamless updates directly from GitHub releases. It also adds new GitHub Actions workflows for building release zip files, updates documentation to reflect the new update mechanism, and bumps the plugin version to 1.1.0.
Automatic update integration:
yahnis-elsts/plugin-update-checkerlibrary as a Composer dependency and implemented a newGitHub_Plugin_Updaterclass inclass-github-plugin-updater.phpto handle update checks and notifications from GitHub releases. The updater is initialized incustom-document-folder.php. [1] [2] [3]custom-document-folder.php,readme.txt, and updated changelogs to reflect the new release and features. [1] [2] [3] [4] [5] [6]Release automation:
.github/workflows/on-release-add.zip.ymlto automatically build and attach a release zip file when a new release is published..github/workflows/manually-build-zip.ymlto allow manual building and uploading of release zip files via workflow dispatch.Documentation and funding:
README.mdto highlight the new automatic update process and simplified installation steps..github/FUNDING.ymlto support various sponsorship platforms.