dbt-coreにおけるOSS活動ことはじめその4 ~ Changieを用いた変更ログ管理の話 ~

本記事が目指すこと

• dbt-coreにおけるOSS活動を始めるにあたってやるべきこと、学びになったことを紹介する
  • 複数回に渡り連載する予定

注意

• 投稿時点(2023/5/31)での情報に基づくため、本記事で紹介した手順が今後も利用できる保証はありません
• なお、本記事は筆者が所属する会社と関係なく、個人の記事であることをご了承ください

背景

• 筆者は、ちゅらデータ株式会社に務める会社員であるが、就業時間中に職務としてのdbt-coreのOSS活動を始めた（OSS活動自体が初めての経験）
• CONTRIBUTING.mdを読めばChangieを用いた変更ログの作成ができる。しかし、ドキュメントには明示的に記載されてない部分があったため、それらの解決策を提示する

前提

• CLAの署名、環境構築、コード修正後にテストを終えていること
  • dbt-coreにおけるOSS活動ことはじめその1 ~ CLAの話 ~
    • https://qiita.com/dai_zamurai/items/6811e1d4ca9e2fad1ca7
  • dbt-coreにおけるOSS活動ことはじめその2 ~ 環境構築の話 ~
    • https://qiita.com/dai_zamurai/items/021e64b4e495b32aa907
  • dbt-coreにおけるOSS活動ことはじめその3 ~ テストの話 ~
    • https://qiita.com/dai_zamurai/items/aecab2aec4b352f6d9a4

用語

• CHANGELOG.md
  • 変更ログを管理するファイル。変更ログには通常、バグ修正や新機能などの変更の記録が含まれる。変更ログは機械ではなく人間のためのものであり、リリースされたバージョンごとに変更された箇所が分かりやすいように記述した方が良い
    • 参考
      • https://keepachangelog.com/en/1.1.0/
      • https://en.wikipedia.org/wiki/Changelog
• Changie
  • 変更ログを管理するツール。CHANGELOG.mdを直接編集せずに、定めたフォーマットを通して変更ログを記載することが可能
    • 参考
      • https://changie.dev/guide/

本編

1. Changieをインストールする

   • 実行環境に合わせてインストールする
     • https://changie.dev/guide/installation/

2. 変更ログファイルを作成する

   1. クローンしたリポジトリ[dbt-core]で以下のコマンドを実行する(.changie.yamlが存在するディレクトリ)
      • changie new
   2. PRの該当する種類を選択する（カーソルキーで操作する）
      • 例
        • Features
          • 機能追加
        • Fixes
          • バグ修正
        • Docs
          • ドキュメント追加・修正
   3. 決められたフォーマットに従い、変更ログを記載する
      • Body
        • 変更ログの本文
      • GitHub Username(s)
        • 該当Issue、PRを作成したGitHubのUsernameを記載
      • GitHub Issue Number
        • 該当Issueの番号
   • 期待される出力
     • 「Fixed-20230525-091955.yaml」のような変更ログファイルが作成されること

3. 変更ログファイルをコミットし、リモートリポジトリにpushする

   • 作成するPRには修正したコードと共に、「変更ログファイル」がコミットされている必要がある。PRに変更ログファイルがない場合はマージされないので注意

以上。なお、PRがマージされてリリースされた際に、作成した変更ログファイルの内容がCHANGELOG.mdにマージされる

終わりに

ちゅらデータでは、クレイジーな仲間を募集しているでござる
データエンジニア、もしくはSE系からデータエンジニアになりたい方がいればぜひ、御仁の力量に応じたグレード（ジュニア/ミドル/シニア）にて、応募するでござる