White Space
WebLife

Github Release を gh コマンドから作成する

  • Git

Github には「リリース」と呼ばれる機能がありますが、こちらは git の機能ではありません。なので、github を操作するコマンドであるghコマンドを使って、タグからリリースを作成する方法をまとめました。

github を操作するための gh コマンドをインストールする（mac + zsh）

mac 以外の環境や gh コマンドについて詳しくは https://snowsystem.net/cloud/github/github-cli-install/ が参考になります。

インストール

brew install gh

ログイン

gh auth login

ログインが成功したら、git 管理しているディレクトリでghコマンドを使うことでリポジトリを操作することができます。

git コマンドでタグを作成する

まずは git コマンドでタグを作成します。例としてv1.0.0という名前のタグを作成。

git tag v1.0.0

リモートに push します

git push origin v1.0.0

gh コマンドでリリースを作成する

次にリリースを作成でいます。github のページ上の GUI でも作成できますが、コマンドでやると楽です。

リリースの一覧を確認してみる

リリースの一覧を確認するにはgh release listを実行します。

gh release list

リリースを作る

今回は例として先程作った v1.0.0 のタグからリリースを作成してみます。

gh release create v1.0.0

コマンドを実行すると、色々聞かれるのでポチポチしていきます。

リリースタイトル入力

Title (optional) # タイトル入力

リリースノートに何を入力するか

? Release notes  [Use arrows to move, type to filter]
   Write my own # 自分で書く
   Write using commit log as template # コミットログを入力する
   Write using git tag message as template # git タグのメッセージを入力する
   Leave blank # 入力しない

prerelease にするかどうか

? Is this a prerelease? (y/N) 
y # prerelease にする
N # prerelease にしない
  • prerelease … リリースがまだ本番反映して良い状態のものでないときに指定するもの

リリースの形式

? Submit?  [Use arrows to move, type to filter]
   Publish release # publish する
   Save as draft # draft で保存する
   Cancel # 処理キャンセル

まずは draft 状態でテストしてみると良いでしょう。

入力が終わると、ターミナルの方に URL が返ってきます。アクセスすると、リリースが作成されていることがわかるはずです。