English | 日本語
YAML ファイルを自動的に整形するための GitHub Actions 用アクションです。コードの一貫性を保ち、レビューやデバッグを容易にします。
name: YAML Formatting
on:
push:
branches:
- main
pull_request:
types: [opened, synchronize, reopened]
workflow_dispatch:
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: yamllint
uses: reviewdog/action-yamllint@v1
with:
github_token: ${{ secrets.github_token }}
fail_on_error: true
- name: yamlfmt
uses: yk-lab/yamlfmt-action@v1- 自動フォーマット:
yamlfmtを使用して YAML ファイルを統一的に整形。 - 簡単導入: 既存のワークフローに数行追加するだけで利用可能。
- 柔軟な設定:
yamlfmtのオプションをカスタマイズ可能。 - 高速: 軽量で高速な動作。
ワークフローのステップに yk-lab/yamlfmt-action を追加します。
name: YAML Formatting
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
jobs:
format:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Run yamlfmt
uses: yk-lab/yamlfmt-action@v1アクションには以下の入力パラメータがあります。
version:yamlfmtのバージョン (デフォルト:latest, 例:v0.13.0)path: フォーマットする YAML ファイルまたはディレクトリのパスdstar: ダブルスター展開を有効にするexclude: 指定したパターンに一致するファイルを除外gitignore_excludes:.gitignoreで指定したパターンに一致するファイルを除外gitignore_path:.gitignoreファイルのパスextensions: フォーマットするファイルの拡張子のリストformatter: 使用するフォーマッタを設定
- name: Run yamlfmt
uses: yk-lab/yamlfmt-action@v1
with:
path: '.github/workflows'A1. はい、.yamlfmt.yaml などの設定ファイルをリポジトリに含めることで、yamlfmt の挙動をカスタマイズできます。
A2. 現在のバージョンでは、yamlfmt のオプションを使用して除外パターンを指定できます。詳しくは yamlfmt のドキュメントをご覧ください。
貢献を歓迎します！バグ報告や機能提案は Issues へ、コードの貢献はプルリクエストをお送りください。
開発手順：
- リポジトリをフォークします。
- 新しいブランチを作成します。
git checkout -b feature/your-feature - 変更をコミットします。
git commit -m 'Add some feature' - ブランチをプッシュします。
git push origin feature/your-feature - プルリクエストを作成します。
このプロジェクトは MIT ライセンスのもとで公開されています。