初めてのgithubで簡易的な流れを完全に理解した話③

Rad Adventar 2022 の20日目の記事です。

https://scrapbox.io/files/6381c8ada58f990021f33c92.png

ご挨拶

3度目の記事ということでそろそろ疲れてきたんじゃないかなと…どうかな？

今回で完結となるので、粘って見ていきましょう！

いつも通りTwitterの個人DMにでも気になった箇所や良い提案ございましたらご指摘願えますと嬉しいです。

(この記事では Ubuntu 20.04 LTS の bash で行っています)

それでは行ってみよう!

tag

解説

tagはコミットに付与することができる名前のようなもの。

リリースするときのコミットを 『Release-ver1.0.0』のように名前をつけてtagづけすると、そこが安定バージョンだとわかりやすいのでつけると将来役に立つ。

注意点としてリモートレポジトリは原則削除したりはできないため、tagを間違えてpushしてしまうと取り返しがつかないことが多いので、慎重に行おう！

手順

1. まずtagを作成する

code:bash

$ git tag <タグ名>

2. -lオプションでtagが作成できているか確認できる

code:bash

3. pushの際そのtagを付与する(pushの項参照)

code:bash

$ git push <リモートレポジトリ名> <タグ名>

push

解説

ローカルレポジトリからリモートレポジトリへ反映するコマンド

※push は他の皆さんと共有する可能性のあるリモートへ反映させるため、原則取り消すことはできない

なので、pushする際はローカルレポジトリに不適切な更新内容が含まれてないかチェックしてから送るように細心の注意を…

https://scrapbox.io/files/63a02ac504050e0023d93e28.png

手順

1. git push コマンドで指定のリモートレポジトリに push できる

code:bash

git push <リモートレポジトリ名> <ローカルレポジトリ名>

pull request

解説

リモートレポジトリのブランチ間で反映させるときに行う行為。

特にリモートレポジトリはReleaseブランチやdevelopブランチなど厳密に分かれている事が多い。

開発途中のブランチをReleaseブランチに誤ってマージ(pull request後に行われる)してしまうことも…そのため protectedなどを設定する。

今回は protected を説明してないので、少し簡単になる。

コミットメッセージのように色々流儀があるみたいですが、今回は自分のプロジェクトで使っているテンプレートを紹介しておきます。

code:template

# title は簡潔に50文字かからないほどで表現(コミットメッセージのように)

* なぜこの変更をするのか

* なにをどう変更したか

* 変更されるクエリ (変更前、変更後)

* 取り扱い変更点

手順

1. レポジトリの『pull requests』から『New pull rquest』。

2. 『base』(マージされる側)と『compare』(マージする側)を選択。

3. タイトルと内容が書けるので、テンプレートに添って書く。

4. 『Create pull request』 を押すと pull request が出せるぞ！

5. 承認されたらマージされる

あとがき

今回初執筆ということで、自分のメモより言葉遣いとか気をつけなければならないことが多くて苦戦しました。

分かりづらい場面もありましたし、どの層に向けてなのかペルソナがはっきりしてなかったのも悪かったかなと思います。

次回はもっとわかりやすい記事を心がけますのでどうぞよろしくお願いします。

長い間ありがとうございました！

/icons/hr.icon