SourceSage v3.1.0 リリースノート

概要

SourceSage V3.1.0では、コードの品質と保守性を向上させるためのリファクタリングと機能改善が行われました。主な変更点は以下の通りです。

新機能

• コミットメッセージのフォーマットとタイプの説明を追加
  • タイトルに種類と概要を記載するフォーマットを導入
  • コミットメッセージの種類（feat, fix, docs, styleなど）の説明を追加
  • ドキュメントテンプレートにコミットメッセージのフォーマットとタイプの説明を追記

機能改善

• コマンドラインからソースコードのリポジトリパスを取得するように修正
  • StagedDiffGeneratorクラスのコンストラクタ引数repo_pathを、定数const.REPO_PATHから現在のワーキングディレクトリを取得するos.getcwd()に変更
  • これにより、コマンドラインからSourceSage.pyを実行する際に、ソースコードのリポジトリパスを適切に取得できるようになり、より柔軟に利用可能に
• IssuesToMarkdownクラスにloguruを使用したログ出力を追加
  • load_data()メソッド内で、データのロード状況をログ出力するように改善
  • create_markdown_files()メソッド内で、マークダウンファイルの作成状況をログ出力するように改善
  • これにより、処理の進行状況や重要な情報がログに記録され、デバッグやモニタリングがしやすくなった
• ドキュメントのフォーマットを改善
  • コミットメッセージのフォーマットをマークダウン形式に変更し、種類の説明を追加
  • これにより、ドキュメントの読みやすさが向上し、コミットメッセージの作成がより明確に

リファクタリング

• 定数の管理方法を改善
  • 環境変数の利用をやめ、定数を一箇所で管理するように変更
  • config/constants.pyファイルを新規作成し、定数を定義
  • SourceSage.pyのmain関数内で定数を使用するように修正
  • これにより、コードの可読性と保守性が向上し、定数の管理がシンプルになった
• Git関係のモジュールのリファクタリング
  • GitHubIssueRetrieve.pyとStagedDiffGenerator.pyの重複部分を削除し、GitHubUtils.pyモジュールにまとめた
  • ChangelogGenerator.pyとDiffChangelogGenerator.pyの共通部分をChangelogUtils.pyモジュールに抽出
  • これにより、モジュール間の依存関係が整理され、コードの可読性と保守性が向上
• ドキュメントテンプレートを整理
  • ドキュメントのテンプレートファイルをdocsディレクトリ下に移動
  • テンプレートファイルのパスを定数で管理するように変更

その他の変更

• .gitignoreファイルの更新
• パッケージのバージョン番号を3.1.0に更新

以上の変更により、SourceSageの機能性と保守性が向上し、より効率的で使いやすいツールになりました。今後もフィードバックを取り入れながら、継続的な改善を行っていきます。