Add the WordPress Plugin Check Action #806
Merged
Conversation
This file contains 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
…; add caching to this so it runs faster; use this action in our plugin check action so we're testing on the final build version
dkotter
changed the title
dkotter
commented
Sep 26, 2024
jeffpaul
reviewed
Sep 27, 2024
| working-directory: ${{ github.event.repository.name }} | ||
|
|
||
| - name: Run plugin check | ||
| uses: wordpress/plugin-check-action@v1 |
There was a problem hiding this comment.
Are there any options to know specifically what checks we're running or is it all-or-nothing?
There was a problem hiding this comment.
By default it will run all tests but you can exclude certain checks or certain categories of checks. If you see a few lines below, we're using the exclude-checks setting to remove a couple checks but we run everything else.
You can see all the checks and categories here: https://github.com/wordpress/plugin-check-action/?tab=readme-ov-file#supported-checks
|
Looks good to me, though we might suggest an upstream enhancement to have some sort of simple report post-run to see what's passed/failed as it wasn't immediately clear where that info was in action run. |
jeffpaul
previously approved these changes
Sep 27, 2024
dkotter
commented
Sep 27, 2024
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.
Description of the Change
WordPress has an official Plugin Check plugin that runs a handful of different checks. They've brought the same functionality into a GitHub Action and this PR adds that as a workflow.
Also made some minor updates to our Build Release Zip Action (which we use here to run tests on the final build) and fix the few issues the Plugin Check found.
Note there are quite a few checks the Plugin Check does, some of which we already do separately (like PHPCS). For now I've left all checks in place other than the Plugin Readme and Plugin Updater checks (both fail here) but we may want to trim the list down if we think some of these are overkill, though they run fast enough I think it's fine.
How to test the Change
Verify the Plugin Check Action is passing on this PR
Changelog Entry
Credits
Props @dkotter
Checklist: