actions-marketplace-validations/fmtya
GitHub Action to run yamlfmt
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stalelast commit Nov 3, 2024
- License
- Public domain
Pinned Snippet
uses: actions-marketplace-validations/norwd_fmtya@1982c6391d5a3e271b5cfebf753a73d7e8138fb0 # no releases — HEAD as of 2026-07-10tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| token | Used to authenticate with GitHub, this should be a PAT with `repo: write` and `workflow: write` permissions. | — | — |
| yamlfmt-version | The specifc version of the yamlfmt tool to use, defaults to the latest vailable version. | — | latest |
| commit-message | The message used to commit any changes made by yamlfmt. | — | Auto yamlfmt |
| commit-user-name | Who the commit should be attributed to, defaults to the GitHub Actions bot. | — | github-actions[bot] |
| commit-user-email | Who the commit should be attributed to, defaults to the GitHub Actions bot. | — | 41898282+github-actions[bot]@users.noreply.github.com |
| signing-private-key | A GPG private key to sign the commit with. This must be exported as an ASCII armored version or its base64 encoding. | — | — |
| signing-passphrase | The password or passphrase for the signing key, if one was used. | — | — |
| signoff-on-commit | Certify the commit, this will use the provided username and email. Must be one of 'true', 'false', 'yes', or 'no'. See https://developercertificate.org | — | false |
| include-files | Which files or file patterns to include in the formatter, one pattern per line. Defaults to all yaml files. The glob paths are implemented using the bmatcuk/doublestar package. | — | **/*.{yaml,yml} |
| exclude-files | Which files or file patterns to exclude from the formatter, one pattern per line. Glob paths follow the same format as `include-files`. | — | — |
| indent-size | How big to make each indent level. | — | 2 |
| include-document-start | Whether yaml files should begin with `---` at the start. | — | true |
| line-ending-type | Determines the type of newline characters to use, must be either `lf` or `crlf`. | — | lf |
| keep-line-breaks | Keep existing line breaks in formatted yaml. | — | true |
| disallow-anchors | Whether to reject any YAML anchors or aliases found in the document. | — | false |
Outputs
no outputs