This action runs [yamllint][yamllint], a tool designed to lint YAML files.
> [!NOTE]
> yamllint checks not only for syntax validity,
> but also detects potential bugs like key repetition,
> and style problems such as lines length, trailing spaces, indentation, etc.
## Usage
To set up the action, you need to create a YAML file that defines your configurations.
Refer to the detailed configuration syntax provided in the [yamllint documentation][yamllint_docs].
### Configuration URL
```yaml
steps:
- name: Cross Yamllint
uses: tmknom/cross-yamllint-action@v0
with:
configuration-url: https://raw.githubusercontent.com/tmknom/configurations/main/yamllint/github-actions.yml
```
### Configuration Path
```yaml
steps:
- name: Cross Yamllint
uses: tmknom/cross-yamllint-action@v0
with:
configuration-path: .yamllint.yml
```