初心者の皆さん、こんにちは！今回は、大規模言語モデル（AI）であるclaude.aiと、プロジェクトのソースコードとファイル構成を単一のマークダウンファイルに変換するPythonスクリプト「SourceSage」を組み合わせて、リリースノートを爆速で作成する方法について解説します。
手順の概要
- SourceSageを使って、プロジェクトのソースコードとファイル構成をマークダウンファイルに変換する
- 不要なファイルやディレクトリは除外するよう設定する
- 生成されたマークダウンファイルの内容をclaude.aiにコピー＆ペーストし、リリースノートの作成を指示する
- claude.aiにissueを勝手に作成しないよう注意する
- claude.aiが生成したリリースノートの文章を必要に応じて修正する
- 完成したリリースノートをGitHubで公開する
では、各手順を詳しく見ていきましょう。
SourceSageでマークダウンファイルを作成
-
SourceSage.pyファイルを、分析対象のプロジェクトのルートディレクトリにコピーします。 -
SourceSage.py内の設定を適切に変更します：folders: 分析対象のディレクトリ（デフォルトは現在のディレクトリ）exclude_patterns: 除外するファイル/フォルダのパターン（重要！）output_file: 出力するマークダウンファイル名
-
ターミナルまたはコマンドプロンプトで、プロジェクトのルートディレクトリに移動し、
python SourceSage.pyを実行します。
これにより、claude.aiがプロジェクトの構造と内容を理解しやすい形式のマークダウンファイルが生成されます。
claude.aiにマークダウンファイルをコピペしてリリースノートを作成
-
claude.aiのチャットインターフェースを開きます。
-
生成されたマークダウンファイルの内容をコピーし、claude.aiにペーストします。
- claude.aiに対して、リリースノートの作成を指示します。例えば、以下のようなプロンプトを与えます：
＊プロンプトは現在研究中．．．
以下のマークダウンファイルの内容を分析し、プロジェクトの新機能、改善点、修正点などを要約したリリースノートを作成してください。ただし、issueは自動的に作成せず、リリースノートの内容のみを提示してください。
- claude.aiが生成したリリースノートを確認します。
リリースノートの文章を修正
- claude.aiが生成したリリースノートを読み、内容が適切かどうかを確認します。
- 必要に応じて、文章の表現や構成を修正します。claude.aiに修正を依頼することも可能です。
GitHubでリリースノートを公開
-
プロジェクトのGitHubリポジトリにアクセスします。
-
新しいリリースを作成し、修正後のリリースノートの内容をコピー＆ペーストします。
-
リリースを公開します。
以上の手順で、claude.aiとSourceSageを活用してリリースノートを爆速で作成することができます。プロジェクトの規模やclaude.aiの性能にもよりますが、従来の手動でのリリースノート作成と比べて大幅に時間を短縮できるでしょう。
ただし、SourceSageで不要なファイルやディレクトリを適切に除外すること、claude.aiにissueを勝手に作成させないよう注意することが重要です。
この方法を活用して、効率的なリリースノートの作成にチャレンジしてみてください！
コメント