https://github.com/norwd/fmtya
GitHub Action to run yamlfmt
https://github.com/norwd/fmtya
actions composite-action github-action github-actions reusable-workflow reusable-workflows tag-management yamlfmt
Last synced: 11 months ago
JSON representation
GitHub Action to run yamlfmt
- Host: GitHub
- URL: https://github.com/norwd/fmtya
- Owner: norwd
- License: unlicense
- Created: 2022-11-22T23:36:49.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-07T20:23:13.000Z (over 1 year ago)
- Last Synced: 2025-06-19T13:46:39.760Z (12 months ago)
- Topics: actions, composite-action, github-action, github-actions, reusable-workflow, reusable-workflows, tag-management, yamlfmt
- Homepage:
- Size: 203 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# fmtya
GitHub Action to run [yamlfmt]
## Usage
### Basic Setup
The following is a reasonable, bare-minimum, setup.
It runs `fmtya` with all the settings set to their default values.
This will run `yamlfmt` on the repository and if any yaml files are reformatted, it will commit them back to the branch that was pushed.
Note that if the default token is used, GitHub Action workflow files cannot be formatted.
This is due to a limitation in GitHub's permissions system. See the [advanced setup] example to see how to format workflow files.
```yaml
---
name: "Format yaml files"
on:
push:
jobs:
yamlfmt:
runs-on: ubuntu-latest
steps:
- uses: norwd/fmtya@v1
with:
exclude-files: '.github/workflows/*.{yaml,yml}'
```
### Advanced Setup
A more advanced setup can customise everything from the commit's message down to the specific version of the `yamlfmt` backend!
The configuration options `fmtya` uses are loosely based on the [`.yamlfmt`] file format.
```yaml
---
name: "Format yaml files"
on:
push:
jobs:
yamlfmt:
runs-on: ubuntu-latest
steps:
- uses: norwd/fmtya@v1
with:
# Due to how GitHub's permissions system is set up, the default token
# does not have the necessary access to update workflow files. If you
# want to want `fmtya` to format the files in the `.github/workflows`
# directory, you will need to set up a PAT with at least write access
# to both the `repo` and `workflows` permissions.
token: ${{ secrets. }}
# By default, `fmtya` uses the latest available version of `yamlfmt`.
# This may result changes to the behaviour of `fmtya`, for example if
# a major version of `yamlfmt` is released. If you prefer to manually
# select a specific version of `yamlfmt`, any released version can be
# pecifically requested.
yamlfmt-version: vX.Y.Z
# If there are files in your repo that follow a different convention,
# are auto-generated, or you just don't want to format for any reason
# at all, you can exclude specific files, or only selectively include
# certain files. The patterns are parsed by `yamlfmt`, and internally
# use https://github.com/bmatcuk/doublestar.
exclude-files: test/data/*.{yaml,yml}
include-files: |
**/*.{yaml,yml}
.yamlfmt
# Specific formatting options to configure the size of indents, or if
# yaml anchors or aliases should or shouldn't be allowed, can be used
# to control how yamlfmt formats the files in your repository.
indent-size: 2
line-ending-type: crlf
include-document-start: false
keep-line-breaks: false
disallow-anchors: true
# If the default commit message is too generic, or you want to create
# a custom commit message, for example, from the output of a previous
# workflow step, you can overwrite the commit message to any string.
commit-message: Reformat .yml files with yamlfmt
# When the formatting changes are made, they are committed by the bot
# account for GitHub Actions, and whoever pushed the unformatted file
# is listed as a co-author. To attribute the commit to a real person,
# or if you want to sign the commit, you can specify the username and
# email the same way you would to `git config user.name `.
commit-user-name:
commit-user-email: }}
signing-passphrase: ${{ secrets. }}
```
[yamlfmt]: https://github.com/google/yamlfmt
[advanced setup]: #advanced-setup
[`.yamlfmt`]: https://github.com/google/yamlfmt#configuration