Provide ability to provide checks to run in addition to auto-discovered checks #12
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
…ration file Signed-off-by: Matthew Weier O'Phinney <[email protected]>
Previously, usage of the "checks" array would cause usage of that value for the matrix, and no further discovery would occur.
This patch adds a new key, "additional_checks", which allows package authors to provide checks to run _in addition to any discovered_.
This allows providing checks for tools the matrix discovery tools do not know about, or providing one-off checks (such as benchmarks or mutation tests).
The syntax for the "additional_checks" key is as follows:
```json
{
"additional_checks": [
{
"name": "(string; REQUIRED) name of the check to run",
"job": {
"command": "(string; REQUIRED) command to run",
"php": "(string; OPTIONAL) PHP version to run on (defaults to stable-php); * indicates all versions",
"dependencies": "(string; OPTIONAL) dependency set to run on (defaults to locked); * indicates all sets",
"extensions": [
"(array of strings; OPTIONAL) specific extensions to install for this check only"
],
"ini": [
"(array of strings; OPTIONAL) specific php.ini settings to use for this check only"
]
}
}
]
}
```
A job per PHP version per dependency set will be created, and the "name" will be appended with "on PHP {VERSION} with {DEPS} dependencies" during an actual run.
The tool discovers checks first, then appends any `additional_checks` are concatenated, and then any `exclude` rules are applied.
Signed-off-by: Matthew Weier O'Phinney <[email protected]>
Signed-off-by: Matthew Weier O'Phinney <[email protected]>
This ensures that we get information about errors flagged better in the GHA env. Signed-off-by: Matthew Weier O'Phinney <[email protected]>
|
Awesome! I'm gonna go try that out as soon as I can. Thanks @weierophinney |
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.
Previously, usage of the "checks" array would cause usage of that value for the matrix, and no further discovery would occur. This patch adds a new key,
additional_checks, which allows package authors to provide checks to run in addition to any discovered. This allows providing checks for tools the matrix discovery tools do not know about, or providing one-off checks (such as benchmarks or mutation tests).The syntax for the
additional_checkskey is as follows:{ "additional_checks": [ { "name": "(string; REQUIRED) name of the check to run", "job": { "command": "(string; REQUIRED) command to run", "php": "(string; OPTIONAL) PHP version to run on (defaults to stable-php); * indicates all versions", "dependencies": "(string; OPTIONAL) dependency set to run on (defaults to locked); * indicates all sets", "extensions": [ "(array of strings; OPTIONAL) specific extensions to install for this check only" ], "ini": [ "(array of strings; OPTIONAL) specific php.ini settings to use for this check only" ] } } ] }A job per PHP version per dependency set will be created, and the "name" will be appended with "on PHP {VERSION} with {DEPS} dependencies" during an actual run.
The tool discovers checks first, then appends any
additional_checksare concatenated, and then anyexcluderules are applied.Fixes #11