バッテラのハローワールド研究室

エンジニア、プログラミングに関する情報を掲載中!

【GitHub】リリースノートを作成する

はじめに

GitHubリリースノートを作る方法についての記事です。

リリースノートとは

機能や不具合修正のログに関するノートのようなものです。

Gリリースノートを作成すると以下の事ができます

  • ログが見れる
  • 前回からの差分を確認
  • プロジェクト一式をダウンロード(各バージョンごとの)

環境

この記事の情報は次のバージョンで動作確認しています。

MacOS Monterey (12.1)
Sourcetree (4.1.1)

タグをつける

まずリリースするコミットに対して「タグ」を付与してプッシュする必要があります。

Gitクライアントツールは人によって異なるのでタグの作成方法については割愛します。

私はSourceTreeというGit管理ソフトを使っています。

なのでこの記事ではSourceTreeの場合の手順で解説していきます。

タグに名前を付けないといけないのですが、私の場合はアプリ内で管理しているバージョンと同じになるようにしています。

例) v1.3.1 とか

GitHubでリリースノートを作成する

タグが作成できたら次はGitHubでの作業になります

GitHubにアクセスして該当プロジェクトページに移動します。

Codeのタブをクリックし、画面右側にあるReleasesをクリック

Draft a new releaseをクリック

Choose a tagをクリックするとプッシュしたタグの一覧が表示されますので、先ほど作成したタグを選びます。

Release title は自由に決めていいですが、私はタグ名と同じ名称にしています。

Describe this releaseに、前バージョンからの追加した機能や不具合修正について、つらつら書きます。

上図ではTargetmasterになっていますが、

どのブランチがアクティブになっているかは人によって異なるので、タグをプッシュしたブランチに切り替えましょう。

最後にページ下部にあるPublish Releaseをクリックするとリリースノートの完成となります。

作成する頻度やタイミングは?

基本的には新しいバージョンをリリースするたびに作成するのが一般的だと思います。

おわりに

リリースノートを作るのは結構簡単にできました。

他人にプログラムを提供したくなったら、

リリースノートのURLを共有すればあとは自由に好きなバージョンをダウンロードしてもらえばいいだけなので楽ちんですね。

以上です。

最後まで見ていただきヘペトナス!

読者登録・Twitterのフォローもお願いします。