Skip to content

Conversation

@ry-itto
Copy link
Owner

@ry-itto ry-itto commented Aug 20, 2025

概要

mainブランチへのpush時に自動的にREADMEを更新する仕組みを実装しました。

変更内容

🎯 主な機能

  • から意図したパッケージ情報を収集・表示
  • main push時に自動的にREADME更新(直接コミット)
  • パッケージの説明とカテゴリ別表示
  • 明示的なバージョン指定がある場合のみバージョン表示

📝 追加ファイル

  • scripts/collect_environment.sh: システム環境情報を収集(JSON出力)
  • scripts/parse_brewfile.py: .Brewfileをパースしてカテゴリと説明を付与
  • scripts/update_readme.py: README.mdを自動生成
  • README.template.md: READMEのテンプレートファイル
  • .github/workflows/ci.yml: 統合されたCIワークフロー

🔄 ワークフローの変更

  • とをに統合
  • mainへのpush時のみREADME更新ジョブを実行
  • タグで無限ループを防止

動作確認

  • ローカルで📊 Collecting environment information...
    📦 Parsing .Brewfile...
    📝 Updating README.md...
    ✅ README.md updated successfully
    • Environment: macOS 15.5 (arm64)
    • 30 Homebrew formulae defined in .Brewfile
    • 12 Homebrew casks defined in .Brewfile実行済み
  • READMEが正しく更新されることを確認

メリット

  • 何をインストールしようとしているかが明確に
  • カテゴリ別でパッケージが整理される
  • 各パッケージの用途が説明付きで表示
  • 不要なバージョン情報を削除してスッキリ

- .Brewfileから意図したパッケージ情報を収集・表示
- main push時に自動的にREADME更新
- パッケージの説明とカテゴリ別表示を実装
- 明示的なバージョン指定がある場合のみバージョン表示

Changes:
- scripts/collect_environment.sh: 環境情報収集スクリプト
- scripts/parse_brewfile.py: Brewfileパーサー
- scripts/update_readme.py: README更新スクリプト
- README.template.md: READMEテンプレート
- .github/workflows/ci.yml: 統合CIワークフロー
- test.ymlとupdate-readme.ymlを統合
- collect_environment.shを削除(システム情報はPythonで直接取得)
- update_readme.pyから未使用の関数を削除
- システム情報取得をget_system_info()に統合

動作は変わらず、コードがシンプルになりました。
@ry-itto ry-itto merged commit e282648 into main Aug 22, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants