mirror of
https://github.com/graycoreio/github-actions-magento2.git
synced 2026-06-08 19:46:41 +00:00
56 lines
2.9 KiB
Markdown
56 lines
2.9 KiB
Markdown
# "Resolve Check Config" Action
|
|
|
|
Reads `.github/check-<kind>.json` (or a path you specify), validates job names against the known list for the selected workflow kind, and emits a per-job filtered version of the `supported-version` matrix. Each job in the output carries an `enabled` flag and its own `matrix`, where every entry's `services` map has been narrowed to the tiers that job actually needs. Consumers gate each job with `fromJSON(...)['<job>'].enabled != false` and feed `fromJSON(...)['<job>'].matrix` into `strategy.matrix`.
|
|
|
|
A missing config file is fine — every known job is emitted with its default tier list.
|
|
|
|
## Inputs
|
|
|
|
| Input | Description | Required | Default |
|
|
|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|----------|-------------------------------|
|
|
| `kind` | Which reusable workflow this config belongs to: `store` or `extension`. Selects the default `config_path`, the known-job list, and the per-job tier defaults. | true | |
|
|
| `matrix` | The matrix JSON emitted by the `supported-version` action. Each entry's `services` map is filtered per-job based on the resolved tier list. | true | |
|
|
| `config_path` | Path to the check-config JSON file, relative to the runner workspace. | false | `.github/check-<kind>.json` |
|
|
|
|
## Usage
|
|
|
|
```yml
|
|
jobs:
|
|
compute_matrix:
|
|
runs-on: ubuntu-latest
|
|
outputs:
|
|
resolved: ${{ steps.resolve.outputs.resolved }}
|
|
steps:
|
|
- uses: graycoreio/github-actions-magento2/supported-version@v8.4.0 # x-release-please-version
|
|
id: supported-version
|
|
with:
|
|
kind: currently-supported
|
|
|
|
- uses: graycoreio/github-actions-magento2/resolve-check-config@v8.4.0 # x-release-please-version
|
|
id: resolve
|
|
with:
|
|
kind: store
|
|
matrix: ${{ steps.supported-version.outputs.matrix }}
|
|
|
|
smoke-test:
|
|
runs-on: ${{ matrix.os }}
|
|
needs: compute_matrix
|
|
if: ${{ fromJSON(needs.compute_matrix.outputs.resolved)['smoke-test'].enabled != false }}
|
|
services: ${{ matrix.services }}
|
|
strategy:
|
|
matrix: ${{ fromJSON(needs.compute_matrix.outputs.resolved)['smoke-test'].matrix }}
|
|
steps:
|
|
- run: echo "running with ${{ toJSON(matrix.services) }}"
|
|
```
|
|
|
|
Example `.github/check-store.json` for opting out of a specific job:
|
|
|
|
```json
|
|
{
|
|
"$schema": "https://raw.githubusercontent.com/graycoreio/github-actions-magento2/main/resolve-check-config/check-store.schema.json",
|
|
"jobs": {
|
|
"coding-standard": false
|
|
}
|
|
}
|
|
```
|