Update readme

This commit is contained in:
Jamie Schouten 2025-02-05 19:44:08 +01:00
parent 2f73945f8f
commit 66712a74ba

View File

@ -10,7 +10,7 @@ jobs:
uses: your-repo/.github/workflows/quality.yml@main uses: your-repo/.github/workflows/quality.yml@main
``` ```
### Secrets and Input Parameters ### Input Parameters
- **username** (optional): - **username** (optional):
- **Type:** `string` - **Type:** `string`
@ -22,6 +22,14 @@ jobs:
- **Default:** `${{ vars.REGISTRY_PASSWORD }}` - **Default:** `${{ vars.REGISTRY_PASSWORD }}`
- **Description:** Password for Docker registry authentication. If not provided, the workflow uses the default value from the `REGISTRY_PASSWORD` environment variable. - **Description:** Password for Docker registry authentication. If not provided, the workflow uses the default value from the `REGISTRY_PASSWORD` environment variable.
- **composer-args** (optional):
- **Type:** `string`
- **Default:**
```bash
--verbose --prefer-dist --no-progress --no-interaction --no-dev --optimize-autoloader --ignore-platform-reqs --no-scripts
```
- **Description:** Arguments passed to the Composer setup command for PHP dependency installation. These arguments can be customized based on specific requirements.
## Workflow Job: `quality` ## Workflow Job: `quality`
The `quality` job runs quality checks on the PHP codebase using the latest version of a Docker image specifically built for quality analysis. The `quality` job runs quality checks on the PHP codebase using the latest version of a Docker image specifically built for quality analysis.