Skip to content

Latest commit

 

History

History
69 lines (48 loc) · 2.16 KB

README.md

File metadata and controls

69 lines (48 loc) · 2.16 KB

yamlfix

Actions Status Actions Status Coverage Status

A simple opinionated yaml formatter that keeps your comments!

Help

See documentation for more details.

Installing

pip install yamlfix

Contributing

For guidance on setting up a development environment, and how to make a contribution to yamlfix, see Contributing to yamlfix.

Donations

Donate using
Liberapay or ko-fi

If you are using some of my open-source tools, have enjoyed them, and want to say "thanks", this is a very strong way to do it.

If your product/company depends on these tools, you can sponsor me to ensure I keep happily maintaining them.

If these tools are helping you save money, time, effort, or frustrations; or they are helping you make money, be more productive, efficient, secure, enjoy a bit more your work, or get your product ready faster, this is a great way to show your appreciation. Thanks for that!

And by sponsoring me, you are helping make these tools, that already help you, sustainable and healthy.

Github Actions

To use this action, create a .github/workflows/yamlfix.yml file with the

name: yamlfix
on: [push, pull_request]
jobs:
  yamlfix:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
    #   - uses: lyz-code/yamlfix@v1
      - uses: dsmello/[email protected]
        with:
          args: --validate-only

If you didn't specify any arguments, the action will run with the default, and will return a error if the yaml is not valid or not formatted.

License

GPLv3