GH Actions: always check that all sniffs are feature complete #656
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
The `phpcsstandards/phpcsdevtools` package includes a script which can check whether sniffs are feature complete, i.e. whether all sniffs have unit tests and documentation. By adding this check to the `basics` GH Actions workflow, we prevent untested and/or undocumented sniffs from entering the repo. For now, the documentation check is silenced. P.S.: the `PHPCSDevTools` package contains a few more goodies which having the package (dev-)required now make available to developers, like the `PHPCSDebug` standard to get detailed information about the tokens in a file. Have a look at the package [readme](https://github.com/PHPCSStandards/PHPCSDevTools) for more information.
jrfnl
force-pushed
the
fix/ghactions-add-feature-complete-check
branch
from
5576de1
to
2f1494d
Compare
rebeccahum
approved these changes
Apr 15, 2021
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.
The
phpcsstandards/phpcsdevtoolspackage includes a script which can check whether sniffs are feature complete, i.e. whether all sniffs have unit tests and documentation.By adding this check to the
basicsGH Actions workflow, we prevent untested and/or undocumented sniffs from entering the repo.For now, the documentation check is silenced.
P.S.: the
PHPCSDevToolspackage contains a few more goodies which having the package (dev-)required now make available to developers, like thePHPCSDebugstandard to get detailed information about the tokens in a file.Have a look at the package readme for more information.
Related to #628