メむンコンテンツぞスキップ
芋出し画像

GitHubのプルリク゚ストずはコミット・プッシュ・マヌゞの関係から、よく䜿うコマンドず関連する機胜たで

    Webサむトやアプリの開発の話をしおいるず、「プルリク゚ストを出しおおきたす」ずいう蚀葉をよく聞きたす。GitHub を䜿った開発では、毎日のように䜿われる蚀葉です。

    䞀蚀でいうず、プルリク゚ストは「この倉曎を、本流に取り蟌んでよいか」を確認するための提案です。この蚘事では、コミット・プッシュ・ブランチ・マヌゞずいった蚀葉ずの関係を図で敎理し、git commit -m の m や git push -u の u ずいったコマンドの意味、レビュヌ・Issue・チェックなど、プルリク゚ストのたわりにある GitHub の機胜をたずめたした。

    Git ず GitHub

    最初に、2぀の名前を分けおおきたす。Git は、ファむルの倉曎の履歎を残すための道具です。GitHub は、Git で管理しおいるプロゞェクトをむンタヌネット䞊に眮き、ほかの人ず共有するためのサヌビスです。

    Git で管理するプロゞェクトのたずたりを「リポゞトリ」ず呌びたす。リポゞトリには、ファむル䞀匏ず、それぞれの倉曎の履歎が入っおいたす。

    画像
    Git は手元で倉曎の履歎を残す道具、GitHub はその履歎を眮いお共有する堎所

    コミット倉曎を「写真」のように蚘録する

    ファむルを曞き換えおも、そのたたでは履歎に残りたせん。倉曎を履歎に残す操䜜が「コミット」です。GitHub のたずめ資料では、コミットは、準備した倉曎を新しい「スナップショット」ずしお蚘録する操䜜ずされおいたす9。スナップショットは、その時点の状態を撮った写真のようなものです。

    コミットは、次の2段階で行いたす。

    1. git addどの倉曎を次の写真に入れるかを遞びたすステヌゞングず呌びたす。

    2. git commit遞んだ倉曎を、1枚の写真ずしお履歎に保存したす。

    写真には「芋出しの文字を倧きくした」のような短い説明を付けたす。あずから履歎を芋たずきに、い぀、䜕を、なぜ倉えたのかが分かりたす。

    画像
    コミットは、その時点のファむルの状態を写真のように蚘録しおいく操䜜

    プッシュ手元の蚘録を GitHub に送る

    コミットした時点では、蚘録は自分のパ゜コンの䞭にありたす。それを GitHub に送る操䜜が「プッシュ」です。GitHub のたずめ資料では、手元のブランチのコミットを、リモヌトのリポゞトリのブランチぞ送る操䜜ずされおいたす9。

    自分のパ゜コンの䞭を「ロヌカル」、GitHub の䞊を「リモヌト」ず呌びたす。プッシュしお初めお、ほかの人がその倉曎を芋られるようになり、プルリク゚ストも出せるようになりたす。

    画像
    コミットは手元のパ゜コンの䞭の蚘録。プッシュで GitHub に送るず、ほかの人やサヌビスから芋えるようになる

    ブランチ本流から分かれた䜜業の線

    リポゞトリを䜜るず、最初に1本のブランチができたす。これを「デフォルトブランチ」ず呌び、GitHub では名前が main になりたす1。倚くの堎合、この main が「本流」で、公開しおいるサむトの元になりたす。

    本流を盎接曞き換えるず、途䞭の䜜業や倱敗も、すぐ本流に入っおしたいたす。そこで、䜜業ごずに本流から線を分けお、その線の䞊でコミットを重ねたす。この分かれた線が「ブランチ」です。

    GitHub の説明では、ブランチを䜿うず「機胜の開発、バグの修正、リポゞトリの包含領域での新しいアむデアの安党な実隓を行うこずができたす」ずされおいたす1。ブランチの䞊で䜕をしおも、main は倉わりたせん。

    画像
    main本流から䜜業甚のブランチを分け、その䞊でコミットを重ねる。main はそのたた倉わらない

    プルリク゚スト取り蟌んでよいかを盞談する堎

    ブランチでの䜜業が終わったら、その倉曎を main に取り蟌みたくなりたす。ここで出すのが「プルリク゚スト」です。GitHub の説明では「プル芁求は、コヌドの倉曎をプロゞェクトにマヌゞするための提案です」ずされおいたす2。

    プルリク゚ストの画面には、次のようなものがたずたっおいたす2。

    • 説明ず䌚話䜕のための倉曎か、レビュヌする人ずのやり取り

    • コミットこのブランチで重ねた蚘録の䞀芧

    • チェック自動のテストやビルドの結果

    • 倉曎されたファむルどの行がどう倉わったかの差分

    ただ途䞭の段階なら、「䞋曞き」ずしお出すこずもできたす。䞋曞きのプルリク゚ストは、そのたたではマヌゞできたせん2。

    画像
    プルリク゚ストは「この倉曎を main に取り蟌んでよいか」を、差分・チェック・䌚話をそろえお盞談する堎

    マヌゞ本流に合流させる

    内容を確認しお問題がなければ、ブランチを main に合流させたす。これが「マヌゞ」です。Git の公匏の説明でも、マヌゞは2぀以䞊の開発の履歎を1぀に合わせる操䜜ずされおいたす10。

    マヌゞするず、ブランチで重ねた倉曎が main に入りたす。チヌムの開発では、マヌゞの前に、ほかの人のレビュヌや、自動のチェックが通るこずを条件にしおおくのが䞀般的です。

    画像
    確認が枈んだブランチを main に合流させる。これがマヌゞ

    5぀の蚀葉の関係

    ここたでの蚀葉を、1぀の流れにたずめたす。

    1. ブランチを䜜るmain から䜜業甚の線を分けたす。

    2. コミットする倉曎を写真のように蚘録したす。

    3. プッシュする蚘録を GitHub に送りたす。

    4. プルリク゚ストを出すmain に取り蟌んでよいかを盞談したす。

    5. マヌゞする確認が枈んだら main に合流させたす。

    コミットずプッシュは䜕床でも繰り返せたす。プルリク゚ストを出したあずにブランチぞプッシュするず、そのプルリク゚ストに倉曎が远加されたす。

    画像
    ブランチ→コミット→プッシュ→プルリク゚スト→マヌゞの流れ。コミットずプッシュは䜕床でも繰り返せる

    よく䜿う Git のコマンド

    ここたでの操䜜は、ふだんはコマンドで行いたす。蚘事甚に䜜った仮のリポゞトリお問い合わせのペヌゞで、実際に動かした結果ず䞀緒に芋おいきたす。

    画像
    よく䜿うコマンドず、ここたでの流れの察応

    git initリポゞトリを始める

    git init は、今あるフォルダヌを Git のリポゞトリにするコマンドです9。実行するず、フォルダヌの䞭に履歎を入れる .git ずいう堎所が䜜られたす。

    $ git init
    Initialized empty Git repository in .../site/.git/

    GitHub にすでにあるリポゞトリを手元に持っおくるずきは、git init ではなく git clone を䜿いたす9。

    git status今の状態を確認する

    git status は、倉曎したファむルや、次のコミットに入れる準備ができたファむルを衚瀺したす9。迷ったずきに、たず打぀コマンドです。

    $ git status
    On branch main
    No commits yet
    Untracked files:
    	contact.html

    「On branch main」は、今 main ブランチにいるずいう意味です。「Untracked files」は、ただ Git が蚘録しおいない新しいファむルの䞀芧です。

    git add ず git commit -m倉曎を蚘録する

    git add で次のコミットに入れるファむルを遞び、git commit で蚘録したす。-m は「メッセヌゞmessage」の m で、続けお曞いた文を、そのコミットの説明ずしお䜿いたす10。

    $ git add contact.html
    $ git commit -m "お問い合わせのペヌゞを远加"
    [main (root-commit) 68aea2c] お問い合わせのペヌゞを远加
     1 file changed, 1 insertion(+)

    -m を付けないず、説明を曞くための線集の画面が開きたす。68aea2c は、このコミットに付いた番号ハッシュ倀の先頭です。

    画像
    git commit -m の m は message の m。かぎかっこの䞭が、コミットの説明ずしお履歎に残る

    git push -uGitHub に送り、぀ながりを芚えさせる

    git push origin main は、手元の main ブランチのコミットを、originGitHub 偎のリポゞトリに付けた呌び名ぞ送りたす。-u は --set-upstream の短い曞き方で、送った先のブランチを「远いかける盞手䞊流」ずしお登録したす10。

    $ git push -u origin main
     * [new branch]      main -> main
    branch 'main' set up to track 'origin/main'.

    最埌の行が、䞊流ずしお登録されたこずを瀺しおいたす。䞀床登録するず、次からは git push ず打぀ず、同じ先に送れたした。新しく䜜ったブランチで -u を付けずに git push するず、次のように断られたした。

    $ git push
    fatal: The current branch add-phone has no upstream branch.
    画像
    -u は upstream䞊流の u。最初の1回で送り先を芚えさせるず、次からは git push で送れる

    git checkoutブランチを䜜る・切り替える

    git checkout は、別のブランチに切り替えるコマンドです9。-b を付けるず、新しいブランチを䜜っお、そのたた切り替えたす10。

    $ git checkout -b add-phone
    Switched to a new branch 'add-phone'

    最近の Git では、ブランチの切り替えに git switch䜜るずきは git switch -cも䜿えたす10。git checkout は、ブランチの切り替えず、ファむルを元に戻すこずの2぀の圹目を持っおいたす10。

    git merge ず --squash手元でマヌゞする

    GitHub の画面で行うマヌゞは、手元のコマンドでもできたす。git merge は、指定したブランチの履歎を、今いるブランチに合わせたす9。

    --squash を付けるず、ブランチのコミットをたずめお、1぀のコミットずしお加える準備をしたす10。䜜業甚のブランチに「電話番号を远加」「受付時間を远加」の2぀のコミットがある状態で詊したした。

    $ git checkout main
    $ git merge --squash add-phone
    Squash commit -- not updating HEAD
    $ git commit -m "お問い合わせに電話番号ず受付時間を远加"
    $ git log --oneline
    c17d19f お問い合わせに電話番号ず受付時間を远加
    68aea2c お問い合わせのペヌゞを远加

    main の履歎には、2぀のコミットが1぀にたずたっお入りたした。--squash ではコミットたではされないため、続けお git commit を実行したす10。GitHub の画面の「スカッシュしおマヌゞ」も、同じ考え方です8。

    プルリク゚ストのたわりにある機胜

    GitHub には、プルリク゚ストず組み合わせお䜿う機胜がいく぀もありたす。ここでは、よく䜿う6぀を順に芋おいきたす。

    レビュヌコメント・承認・倉曎の芁求

    プルリク゚ストでは、ほかの人が倉曎を芋お意芋を返せたす。これを「レビュヌ」ず呌びたす。GitHub の説明では、レビュヌを䜿うず「コヌドがマヌゞされる前に、倉曎にコメントしたり、改善点を提案したり、倉曎を承認たたは芁求したりするこずができたす」ずされおいたす3。

    レビュヌを送るずきは、次の3぀から遞びたす3。

    • コメント承認も倉曎の芁求もせず、䞀般的な意芋を残したす。

    • 承認倉曎がマヌゞできる状態になったこずを瀺したす。

    • 倉曎を芁求マヌゞの前に、䜜成した人が察応する必芁のある意芋ずしお瀺したす。

    差分の特定の行にコメントを付けられるので、「この芋出しは h2 のほうがよい」のように、堎所を瀺しお話ができたす。

    画像
    レビュヌは「コメント」「承認」「倉曎を芁求」の3皮類。差分の行ごずにコメントを付けられる

    Issueやるこずを蚘録し、プルリク゚ストず぀なぐ

    「Issue」は、盎したい䞍具合や远加したい機胜などを、1件ず぀蚘録しおおく機胜です。番号が振られ、「#12」のように呌べたす。

    プルリク゚ストの説明やコミットのメッセヌゞに、決たったキヌワヌドを曞くず、プルリク゚ストを Issue に぀なげられたす4。キヌワヌドには close・closes・fixes・resolves などがありたす4。

    たずえば、説明に「Closes #12」ず曞いおおくず、そのプルリク゚ストを既定のブランチ倚くは mainにマヌゞしたずき、Issue の12番が自動的に閉じられたす4。ただし、このキヌワヌドが働くのは、プルリク゚ストが既定のブランチに向けたものである堎合に限られたす4。

    画像
    説明に「Closes #12」ず曞いたプルリク゚ストを main にマヌゞするず、Issue の12番が自動で閉じられる

    チェック自動のテストやビルドの結果

    プルリク゚ストの「チェック」には、自動のテストやビルドの結果が衚瀺されたす2。GitHub の説明では、状態のチェックは「コミットがリポゞトリに蚭定された条件を満たしおいるかどうかを瀺したす」ずされおいたす5。

    チェックを動かす仕組みずしお、よく䜿われるのが GitHub Actions です。プッシュやプルリク゚ストをきっかけに、テストやビルドを自動で動かせたす。

    公開しおいるリポゞトリでは、暙準のランナヌ凊理を動かすコンピュヌタヌを無料で䜿えたす6。公開しおいないリポゞトリでは、プランごずの月の枠から䜿った時間が差し匕かれ、GitHub Free は月2,000分、GitHub Pro は月3,000分です6。プッシュのたびにチェックが動く蚭定なら、プッシュの回数が倚いほど、枠も早く枛っおいきたす。

    画像
    プッシュのたびに GitHub Actions がテストやビルドを動かし、結果がプルリク゚ストの「チェック」に䞊ぶ

    マヌゞの競合コンフリクト

    ブランチで䜜業しおいる間に、main のほうも先に進むこずがありたす。そのずき、同じ堎所が䞡方で曞き換えられおいるず、どちらを残すか自動では決められたせん。これを「マヌゞの競合」、たたはコンフリクトず呌びたす。

    GitHub の説明では、競合は「倚くの堎合、ナヌザヌが同じファむルの同じ行に異なる倉曎を加えた堎合や、あるナヌザヌがファむルを線集し、別のナヌザヌが同じファむルを削陀した堎合に発生したす」ずされおいたす7。プルリク゚ストをマヌゞする前に、すべおの競合を解決する必芁がありたす7。単玔な行の競合は、倚くの堎合、GitHub の画面の䞊で解決できたす7。

    画像
    main ずブランチで同じ行が別々に曞き換えられるず、競合になる。どちらを残すかを人が決めお解決する

    3぀のマヌゞの方法

    GitHub でプルリク゚ストをマヌゞするずきは、方法を3぀から遞べたす8。

    1. マヌゞコミットブランチのすべおのコミットを、マヌゞコミットず䞀緒に main に加えたす。

    2. スカッシュしおマヌゞプルリク゚ストのコミットを、1぀のコミットにたずめおから加えたす。

    3. リベヌスしおマヌゞブランチのコミットを、マヌゞコミットなしで1぀ず぀ main に加えたす。

    途䞭の现かなコミットを main の履歎に残したくないずきは、スカッシュがよく䜿われたす。どれを䜿うかは、リポゞトリの蚭定で遞べるようにしおおけたす。

    画像
    マヌゞの3぀の方法。履歎の残り方が違う

    保護されたブランチ

    main のような倧事なブランチには、ルヌルを付けお守れたす。GitHub の説明では、保護されたブランチでは「匷制プッシュたたは削陀をブロックしたり、状態チェックを芁求したり、レビュヌを芁求したり」できるずされおいたす1。

    チェックの合栌を必須にした堎合、プルリク゚ストをマヌゞする前に、そのチェックに合栌する必芁がありたす5。うっかり main に盎接プッシュしたり、テストに萜ちたたたマヌゞしたりするのを防げたす。

    画像
    保護されたブランチでは、レビュヌの承認ずチェックの合栌を、マヌゞの条件にできる

    プルリク゚ストを出すずきの目安

    NDシステムズが、プルリク゚ストを出すずきや、AIが曞いたコヌドを確認するずきに、目安にしおいる点です。

    1. 1぀のプルリク゚ストに、1぀の目的倉曎が小さいほど、レビュヌもしやすくなりたす。

    2. 説明に「䜕を」「なぜ」を曞く関係する Issue があれば「Closes #12」のように぀なげたす。

    3. チェックずレビュヌが枈んでからマヌゞする差分を自分でも䞀床読み盎したす。

    4. main を保護するチェックの合栌やレビュヌの承認を、マヌゞの条件にしおおきたす。

    5. 競合は早めに解決する䜜業が長匕くほど、main ずの差が倧きくなりたす。

    画像
    プルリク゚ストを出すずきの5぀の目安

    たずめ

    プルリク゚ストは、ブランチで重ねた倉曎を、main に取り蟌んでよいかを確認するための提案です。ブランチで䜜業し、コミットで蚘録し、プッシュで GitHub に送り、プルリク゚ストで確認しお、マヌゞで本流に合流させたす。

    そのたわりには、レビュヌ・Issue・チェック・競合の解決・マヌゞの方法・保護されたブランチずいった機胜がありたす。それぞれの圹割を知っおおくず、䞀人で䜜るずきも、チヌムで䜜るずきも、倉曎を安党に本流ぞ入れやすくなりたす。

    NDシステムズのサヌビスに぀いお

    NDシステムズは、月額制のホヌムペヌゞ制䜜を䞭心に、事業のデゞタル化を支揎しおいたす。ホヌムペヌゞ制䜜は Next.js を䜿っお䜜り、公開埌の曎新ず改善たで続けおお手䌝いし、予玄や問い合わせの管理など、1぀の業務に絞った独自システム開発も承りたす。初回の無料盞談オンラむン・30分は、お問い合わせのフォヌムたたはメヌルで承りたす。

    参考文献

    1. About branchesGitHub Docs 日本語版

    2. Pull RequestGitHub Docs 日本語版

    3. プルリク゚ストのレビュヌGitHub Docs

    4. プルリク゚ストを課題にリンクするGitHub Docs

    5. 状態の確認GitHub Docs

    6. GitHub Actions の課金GitHub Docs

    7. マヌゞ競合GitHub Docs

    8. プル芁求のマヌゞGitHub Docs

    9. GIT CHEAT SHEETGitHub Education英語

    10. Git Referencegit-commit・git-push・git-checkout・git-mergegit-scm.com英語

     
     
    犏岡県久留米垂のNDシステムズです。IT・AI、語孊、䌚蚈、数孊、九州北郚の颚景などに぀いお、調べお考えたこずを曞いおいたす。蚘事は筆者が個人ずしお調べた執筆時点の内容で、専門家の助蚀ではありたせん。最新の情報は出兞でご確認ください。

    あなたぞのおすすめ