{"id":15097552,"url":"https://github.com/yk-lab/yamlfmt-action","last_synced_at":"2026-01-06T16:57:55.780Z","repository":{"id":252733091,"uuid":"841263413","full_name":"yk-lab/yamlfmt-action","owner":"yk-lab","description":"yamlfmt for GitHub Actions | yamlfmt-action は YAML ファイルを自動的に整形する GitHub Actions 用アクションです。CI/CD パイプラインでのコード品質向上に役立ちます。","archived":false,"fork":false,"pushed_at":"2024-09-16T14:16:45.000Z","size":11,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-01T19:45:52.328Z","etag":null,"topics":["formatter","github-actions","yaml","yaml-format","yamlfmt"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yk-lab.png","metadata":{"files":{"readme":"README.ja.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-12T03:53:07.000Z","updated_at":"2024-09-16T14:16:47.000Z","dependencies_parsed_at":"2024-09-20T00:00:48.012Z","dependency_job_id":null,"html_url":"https://github.com/yk-lab/yamlfmt-action","commit_stats":null,"previous_names":["yk-lab/yamlfmt-action"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yk-lab%2Fyamlfmt-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yk-lab%2Fyamlfmt-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yk-lab%2Fyamlfmt-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yk-lab%2Fyamlfmt-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yk-lab","download_url":"https://codeload.github.com/yk-lab/yamlfmt-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245878929,"owners_count":20687297,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["formatter","github-actions","yaml","yaml-format","yamlfmt"],"created_at":"2024-09-25T16:23:31.255Z","updated_at":"2026-01-06T16:57:55.768Z","avatar_url":"https://github.com/yk-lab.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# yamlfmt-action\n\n[![GitHub release (latest by date)](https://img.shields.io/github/v/release/yk-lab/yamlfmt-action?style=for-the-badge)](https://github.com/yk-lab/yamlfmt-action/releases)\n[![GitHub license](https://img.shields.io/github/license/yk-lab/yamlfmt-action?style=for-the-badge)](https://github.com/yk-lab/yamlfmt-action?tab=MIT-1-ov-file#readme)\n[![GitHub stars](https://img.shields.io/github/stars/yk-lab/yamlfmt-action?style=for-the-badge)](https://github.com/yk-lab/yamlfmt-action/stargazers)\n[![GitHub watchers](https://img.shields.io/github/watchers/yk-lab/yamlfmt-action?style=for-the-badge)](https://github.com/yk-lab/yamlfmt-action/watchers)\n[![DeepWiki](https://img.shields.io/badge/DeepWiki-yk--lab%2Fyamlfmt--action-blue.svg?style=for-the-badge)](https://deepwiki.com/yk-lab/yamlfmt-action)\n![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/yk-lab/yamlfmt-action?style=for-the-badge)\n\n[English](README.md) | 日本語\n\nYAML ファイルを自動的に整形するための GitHub Actions 用アクションです。コードの一貫性を保ち、レビューやデバッグを容易にします。\n\n## TL;DR\n\n```yaml\nname: YAML Formatting\n\non:\n  push:\n    branches:\n      - main\n  pull_request:\n    types: [opened, synchronize, reopened]\n  workflow_dispatch:\n\njobs:\n  lint:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n      - name: yamllint\n        uses: reviewdog/action-yamllint@v1\n        with:\n          github_token: ${{ secrets.github_token }}\n          fail_on_error: true\n      - name: yamlfmt\n        uses: yk-lab/yamlfmt-action@v1\n```\n\n## 特徴\n\n- **自動フォーマット**: `yamlfmt` を使用して YAML ファイルを統一的に整形。\n- **簡単導入**: 既存のワークフローに数行追加するだけで利用可能。\n- **柔軟な設定**: `yamlfmt` のオプションをカスタマイズ可能。\n- **高速**: 軽量で高速な動作。\n\n## 目次\n\n- [使用方法](#使用方法)\n- [オプション](#オプション)\n- [よくある質問](#よくある質問)\n- [貢献](#貢献)\n- [ライセンス](#ライセンス)\n- [関連リンク](#関連リンク)\n\n## 使用方法\n\nワークフローのステップに `yk-lab/yamlfmt-action` を追加します。\n\n```yaml\nname: YAML Formatting\n\non:\n  push:\n    branches: [ main ]\n  pull_request:\n    branches: [ main ]\n\njobs:\n  format:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n      - name: Run yamlfmt\n        uses: yk-lab/yamlfmt-action@v1\n```\n\n## オプション\n\nアクションには以下の入力パラメータがあります。\n\n- `version`: `yamlfmt` のバージョン (デフォルト: `latest`, 例: `v0.13.0`)\n- `path`: フォーマットする YAML ファイルまたはディレクトリのパス\n- `dstar`: ダブルスター展開を有効にする\n- `exclude`: 指定したパターンに一致するファイルを除外\n- `gitignore_excludes`: `.gitignore` で指定したパターンに一致するファイルを除外\n- `gitignore_path`: `.gitignore` ファイルのパス\n- `extensions`: フォーマットするファイルの拡張子のリスト\n- `formatter`: 使用するフォーマッタを設定\n\n### パラメータの使用例\n\n```yaml\n- name: Run yamlfmt\n  uses: yk-lab/yamlfmt-action@v1\n  with:\n    path: '.github/workflows'\n```\n\n## よくある質問\n\n### Q1. `yamlfmt` の設定ファイルを使用できますか？\n\nA1. はい、`.yamlfmt.yaml` などの設定ファイルをリポジトリに含めることで、`yamlfmt` の挙動をカスタマイズできます。\n\n### Q2. 特定のファイルやディレクトリを除外できますか？\n\nA2. 現在のバージョンでは、`yamlfmt` のオプションを使用して除外パターンを指定できます。詳しくは [yamlfmt のドキュメント](https://github.com/google/yamlfmt)をご覧ください。\n\n## 貢献\n\n貢献を歓迎します！バグ報告や機能提案は [Issues](https://github.com/yk-lab/yamlfmt-action/issues) へ、コードの貢献はプルリクエストをお送りください。\n\n**開発手順：**\n\n1. リポジトリをフォークします。\n2. 新しいブランチを作成します。`git checkout -b feature/your-feature`\n3. 変更をコミットします。`git commit -m 'Add some feature'`\n4. ブランチをプッシュします。`git push origin feature/your-feature`\n5. プルリクエストを作成します。\n\n## ライセンス\n\nこのプロジェクトは [MIT ライセンス](LICENSE)のもとで公開されています。\n\n## 関連リンク\n\n- [yamlfmt リポジトリ](https://github.com/google/yamlfmt)\n- [GitHub Actions ドキュメント](https://docs.github.com/ja/actions)\n- [他の GitHub Actions](https://github.com/marketplace?type=actions)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyk-lab%2Fyamlfmt-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyk-lab%2Fyamlfmt-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyk-lab%2Fyamlfmt-action/lists"}