Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Output a success message if no errors or warnings are found. #689

Merged
merged 5 commits into from
Oct 3, 2024

Conversation

pbiron
Copy link
Contributor

@pbiron pbiron commented Oct 2, 2024

fixes #685

When no errors or warnings are found, output a success message with that same text that is used in Tools > Plugin Check.

Before merging this, please verify that producing output on success doesn't cause problems with plugin-check-action.

Copy link

github-actions bot commented Oct 2, 2024

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: pbiron <[email protected]>
Co-authored-by: swissspidy <[email protected]>
Co-authored-by: davidperezgar <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@swissspidy
Copy link
Member

Would you mind updating the Behat tests to cover this new scenario? :-)

@pbiron
Copy link
Contributor Author

pbiron commented Oct 2, 2024

@swissspidy I'm just looking at that now. I'm not great with Behat, but I'll try.

@pbiron
Copy link
Contributor Author

pbiron commented Oct 2, 2024

@swissspidy OK, the test with --ignore-errors is now succeeding and the code linting is now passing as well.

There is no existing test for a plugin with no (non-ignored) errors or warnings (i.e., that expects STDOUT to be empty). Would it be helpful to add one?

Not sure why some of the tests were "canceled" after the last commit. Can you please restart the tests?

@pbiron
Copy link
Contributor Author

pbiron commented Oct 2, 2024

All tests are passing now ;-)

Copy link
Member

@swissspidy swissspidy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great to me, thanks!

@swissspidy swissspidy added this to the 1.2.0 milestone Oct 2, 2024
@pbiron
Copy link
Contributor Author

pbiron commented Oct 2, 2024

will the plugin-check-action need to be updated? Since I don't use GHA, I don't know if it will fail when the success message is output.

@davidperezgar
Copy link
Member

Thanks Paul for the PR! I've requested one change.

@davidperezgar
Copy link
Member

Nice!

@davidperezgar davidperezgar merged commit 083cd22 into WordPress:trunk Oct 3, 2024
29 checks passed
@pbiron pbiron deleted the cli-success-message branch October 3, 2024 20:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

CLI: if "wp plugin check <my-plugin>" finds no errors/warnings, then output a message saying such
3 participants