feat: add badges for PHPUnit and code quality checks#220
Merged
Conversation
github-actions
Bot
added
documentation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves project visibility by expanding README.md with CI/status badges and enhances CI by running PHPUnit/PHPCS on pushes to main, plus publishing coverage/mutation badge endpoint JSON to a dedicated badges branch.
Changes:
- Update PHPUnit + PHPCS workflows to run on both
pull_requestandpushtomain. - Add a
badgesjob to generate Shields.io endpoint JSON for coverage and mutation score and push it to abadgesbranch. - Expand
README.mdwith additional status/quality badges and minor Inspector section formatting.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| README.md | Adds multiple project/CI badges and a small Inspector docs tweak. |
| .github/workflows/phpunit.yml | Adds push-to-main trigger and a new job that generates and publishes badge JSON. |
| .github/workflows/phpcs.yml | Adds push-to-main trigger for PHPCS checks. |
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 enhances CI workflows and improves project visibility by updating GitHub Actions triggers, adding automated badge generation for test coverage and mutation score, and enriching the
README.mdwith new status badges. The main changes are grouped below:CI Workflow Improvements:
.github/workflows/phpcs.ymland.github/workflows/phpunit.ymlto run on both pull requests and pushes to themainbranch, ensuring checks are performed on all mainline changes. [1] [2]badgesjob to.github/workflows/phpunit.ymlthat generates Shields.io-compatible JSON badge data for code coverage and mutation score, and publishes it to a dedicatedbadgesbranch for use in README badges.Documentation and Badge Updates:
README.mdto include new status badges for downloads, PHP version, PHPUnit, code coverage, mutation score, functional tests, Magento compatibility, PHPCS, static analysis, and linting, providing better project status visibility.