Help us understand the problem. What is going on with this article?

git tag と GitHub の Release 機能でプロっぽさを出してみよう

本稿は Git Advent Calendar 2019 の12日目の記事です。
昨日の記事は @miiina016 さんによる ブランチを切ってinitialコミットまでするalias でした。

概要

こんにちは。とつぜんですが、みなさまは GitHub で以下のようなものを見かけませんでしょうか。

↓こんなのとか

2019-12-09_00h46_44.png

↓こんなのとか

2019-12-09_00h48_11.png

※画像は Laravel先生の公式リポジトリ からお借りしました。

なんというかこんな風にバージョン6.5.2とか書かれると プロっぽさ というか 製品感がある というか。とにかく 見た目カッチョイイ ですよね(語彙力

これっていったいどうやってるんだろうと思って少し調べてみたところ、実はごく簡単な方法で実現ができるということがわかりました。そんなわけで今日はその方法を紹介してみたいとおもいます。

適当なリポジトリをつくります

単に私が検証用のリポジトリを用意しているだけなので、ここは読み飛ばしてもらってOKですw
下記は特になんの変哲もないリポジトリです。
2019-12-09_01h09_33.png

tagをつけます

v1.0 という名前のタグを付けてリモートへ push します。

$ git tag -a v1.0 -m 'version 1.0'
$ git push origin v1.0
Counting objects: 1, done.
Writing objects: 100% (1/1), 162 bytes | 0 bytes/s, done.
Total 1 (delta 0), reused 0 (delta 0)
To https://github.com/Jpsern/test-product.git
 * [new tag]         v1.0 -> v1.0

おや? release のようすが・・・

さきほどまではなかった release の数字が0から1に増えてますね。
2019-12-09_01h23_25.png

クリックしてみるとこんなかんじです。
2019-12-09_01h26_48.png

おお、バージョンがつきましたね。

しかし、もう少しなにかが足りない

さっき見た Laravel のリポジトリと比べると何かまだ見た目が寂しいですね。
ここからが Release 機能の出番です。使い方は簡単です。

1. Draft a new release をクリックします

2019-12-09_01h32_37.png

2. 必要な情報を入力します

例えばこんなかんじです。一番上には先ほど作ったタグの名前を入れます。2つめはタイトルです。一番下のテキストエリアはリリース内容の詳細です。
2019-12-09_01h39_26.png

入力が終わったら Publish release を押します。

すると・・・?

2019-12-09_01h41_40.png

おお、なんということでしょう・・・!(古い)
冒頭でお見せしました Laravel の公式リポジトリと同じようなかんじになりましたね:relaxed:

ちなみに

下記の入力フォームのキャプチャを見ていただくと、Choose an existing tag, or create a new tag on publish とタグの入力フォームのそばに書かれています。

Release の登録時に存在しない tag の名前を指定すると、tag の生成も行います。なので、実は GitHub 上ですべて完結することも可能です。タグの名前を入力すると、そのタグが既に存在するかどうかメッセージも出してくれるので、こちらのほうが作業効率もよかったりします。

スクリーンショット 2019-12-09 10.30.01.png

スクリーンショット 2019-12-09 10.28.27.png

ただ、今回は tag の追加と、Release の編集を分けて説明したかったので前述までのような形をとりました。なので慣れている人はGitHub側の Release 機能でタグの追加からRelease編集までまとめて行うと良いのではないかと思います。

追記

@munieru_jp さんから、さらにプロっぽく見せることができるナイスなアドバイスをいただきましたので追記します。

バージョン表記は セマンティックバージョニング にしたがって行うようにすると、よりプロっぽさが増します。

細かい話は前述のリンク先を見てください。
超おおざっぱに説明しますと、以下の書式でバージョンを表記することです。必ず3ケタで表記します。

メジャー番号.マイナー番号.パッチ番号

例:1.0.0、1.1.0、など

感想

ということで味気なかった私のテスト用リポジトリでさえ少し立派に見えるようになりましたw
みなさまも制作されたソフトウェア等を GitHub で管理する際には git tag や、GitHub の Release 機能を使うと、それだけでちょっと見た目がいいかんじになるのでテンションが上がるとおもいます。気が向いた方はぜひ試してみてください:thumbsup:

お世話になった参考リンク様

tommy_aka_jps
小ネタばかり投稿しているひとです。
https://jpsern.com
giftpad
ギフトカードで幸せを届ける!世界を笑顔にするベンチャー企業
https://giftpad.jp/
Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
Comments
No comments
Sign up for free and join this conversation.
If you already have a Qiita account
Why do not you register as a user and use Qiita more conveniently?
You need to log in to use this function. Qiita can be used more conveniently after logging in.
You seem to be reading articles frequently this month. Qiita can be used more conveniently after logging in.
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
ユーザーは見つかりませんでした