https://github.com/actungs/yamllint-composite-action
A GitHub composite action to run yamllint.
https://github.com/actungs/yamllint-composite-action
composite-action github-actions linter yaml yamllint
Last synced: 3 months ago
JSON representation
A GitHub composite action to run yamllint.
- Host: GitHub
- URL: https://github.com/actungs/yamllint-composite-action
- Owner: actungs
- License: mit
- Created: 2023-03-10T10:47:06.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-11-20T19:02:15.000Z (7 months ago)
- Last Synced: 2026-03-28T09:39:27.376Z (3 months ago)
- Topics: composite-action, github-actions, linter, yaml, yamllint
- Homepage:
- Size: 26.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Yamllint Composite Action
[][releases]
[](./LICENSE)
A [GitHub composite action][gh-composite-action] to run [yamllint][yamllint], a linter for YAML files.
[gh-composite-action]: https://docs.github.com/en/actions/creating-actions/creating-a-composite-action
[yamllint]: https://yamllint.readthedocs.io/en/stable/index.html
## Usage
A simplified example on how this action can be utilized, could look like this.
```yaml
on: [pull_request]
jobs:
lint_yaml:
runs-on: ubuntu-latest
name: Lint YAML files
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Lint YAML
id: yamllint
uses: actungs/yamllint-composite-action@v1
- name: Use linter output
if: always()
run: echo ${{ steps.yamllint.outputs.lint_output }}
```
See this action [releases][releases] or [tags][tags] for all available versions.
[releases]: https://github.com/actungs/yamllint-composite-action/releases
[tags]: https://github.com/actungs/yamllint-composite-action/tags
## Inputs
This action accepts the following inputs.
| Name | Description | Required | Default |
|-----------------|---------------------------------------------------------------------------------------------|:--------:|:-------------------------:|
| `files_or_dirs` | A space separated list of files or directories to be linted | no | current working directory |
| `config_file` | Path to a custom configuration file | no | "" |
| `config_data` | Custom configuration (as YAML source) | no | "" |
| `strict` | Return non-zero exit code on warnings as well as errors | no | false |
| `no_warnings` | Output only error level problems | no | false |
| `format` | The format for parsing output. Available options: parsable, standard, colored, github, auto | no | auto |
## Outputs
This action returns the following outputs.
| Name | Description |
|---------------|----------------------------|
| `lint_output` | Result from yamllint check |
**Note**: When using the output in a follow up step(s),
one of these conditions `if: always()` or `if: success() || failure()` should be added,
to prevent the step to be skipped when errors are found.
## License
Distributed under the MIT License. See [LICENSE](./LICENSE) for more information.