25 lines
1.1 KiB
Markdown
25 lines
1.1 KiB
Markdown
# vacuum-lint
|
|
|
|
Action for validating and linting OpenAPI specifications using [Vacuum](https://github.com/daveshanley/vacuum).
|
|
|
|
## Inputs
|
|
|
|
| Input | Required | Default | Description |
|
|
|-------|----------|---------|-------------|
|
|
| `spec-dir` | No | `spec` | Directory containing the OpenAPI spec |
|
|
| `spec-filename` | No | `openapi.json` | Filename of the OpenAPI spec |
|
|
| `rules-filename` | No | `vacuum.rules.yaml` | Filename of the lint rules config file |
|
|
| `ignore-filename` | No | `vacuum.ignore.yaml` | Filename of the lint ignore file |
|
|
| `min-score` | No | `70` | Minimum linting score for the check to pass |
|
|
|
|
## Usage
|
|
|
|
```yaml
|
|
- uses: https://schmalz-git.git.onstackit.cloud/schmalz/shared-actions/vacuum-lint@vacuum-lint-v1
|
|
```
|
|
|
|
## Notes
|
|
|
|
- If `rules-filename` is found inside `spec-dir`, it is passed to Vacuum via `-r` to apply custom rulesets; otherwise Vacuum uses its default rules.
|
|
- If `ignore-filename` is found inside `spec-dir`, it is passed to Vacuum via `--ignore-file` to suppress known violations.
|
|
- The action fails when the computed linting score falls below `min-score`.
|