yamllint

GitHub Action to validate/lint YAML files.

Usage

name: Example

on:
  - push
  - pull_request

jobs:
  test:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v2

      - uses: actionhippie/yamllint@v1
        with:
          strict: true

Inputs

config

Path to custom configuration file

format

Output formatter, defaults to parsable

warnings

Enable warning message output

strict

Return non-zero exit code on warnings

path

Path to check, defaults to .

print

Print messages directly, defaults to true

Outputs

messages

Generated validation/linting messages

Security

If you find a security issue please contact thomas@webhippie.de first.

Contributing

Generally we are following conventional commits when we apply changes. That way we are able to generate proper changelogs for every release. Please use always pull requests to integrate new functionalities or to fix issues.

For the release process we are following semantic versioning which clearly indicates if a new version just resolves bugs, includes new features or even includes breaking changes.

After installing the tools via mise install as described above set up the pre-commit hooks so they run automatically on every commit:

prek install --hook-type pre-commit --hook-type commit-msg

prek is managed by mise and will be available after mise install.

If you have changed something on the source you should simply commit following the mentioned conventions:

git checkout -b feat/new-feature
git add --all
git commit -m 'feat: added awesome new feature'
git push --set-upstream origin feat/new-feature

After pushing your changes into the Git repository you should create a pull request on GitHub. If the pull request have been merged and everything built fine it will also create automatically a new release at least once a week.

Authors

• Thomas Boerger

License

Apache-2.0

Copyright

Copyright (c) 2021 Thomas Boerger <thomas@webhippie.de>