🔰はじめての方へ

【GitHub】CLIを使ったプルリクエスト作成ガイド

Github
記事内に広告が含まれています。
スポンサーリンク

初心者向けに、GitHub CLIを使ってコマンドラインでプルリクエストを作成する方法を説明します。

ステップ1: GitHub CLIをインストール

まず、GitHub CLIをインストールします。Homebrewを使用するのが簡単です。

brew install gh

ステップ2: GitHub CLIで認証

GitHub CLIを初めて使う時は、GitHubアカウントと連携する必要があります。

gh auth login

このコマンドを実行すると、以下の質問が順に出ます。

質問1: GitHub の使用場所

? Where do you use GitHub? GitHub.com

GitHub.com を選択します。

質問2: 希望するプロトコル

? What is your preferred protocol for Git operations on this host? HTTPS

HTTPS を選択します。(シンプルで初心者向けです)

質問3: Git認証方法

? Authenticate Git with your GitHub credentials? Yes

Yes を選択します。

質問4: GitHub CLIの認証方法

? How would you like to authenticate GitHub CLI? Login with a web browser

Login with a web browser を選択します。

質問5: ワンタイムコードの確認

以下のようなメッセージが表示されます:

! First copy your one-time code: XXXX-XXXX
Press Enter to open https://github.com/login/device in your browser…
  1. ワンタイムコードをコピーします(例:4837-CDBD)
  2. Enter キーを押すと、ブラウザが自動で開きます
  3. ブラウザで https://github.com/login/device が開いたら、コピーしたコードを入力
  4. 「Authorize」をクリック
  5. 認可が完了したら、ターミナルに戻って Enter キーを押す

これで認証が完了します!

ステップ3: 新しいブランチを作成

git checkout -b feature/my-feature 

feature/my-feature の部分は、あなたのフィーチャー名に変更してください。

ステップ4: 変更をコミット

ファイルを編集した後、変更をステージングしてコミットします。

git add .
git commit -m "説明的なコミットメッセージ" 

ステップ5: ブランチをプッシュ

git push -u origin feature/my-feature 

ステップ6: プルリクエストを作成

最後に、GitHub CLIでプルリクエストを作成します。

gh pr create --title "プルリクエストのタイトル" --body "詳細な説明" --base develop 

パラメータの説明:

  • –title:プルリクエストのタイトル
  • –body:プルリクエストの説明(省略可能)
  • –base:マージ先のブランチ(例:main、developなど)

実行するとプルリクエストが作成され、URLが表示されます!

トラブルシューティング

エラー: "No commits between [ブランチ] and [ベースブランチ]" 

このエラーは、ベースブランチと同じコミットを指している場合に発生します。

解決策:

  1. ファイルに実際の変更を加える
  2. コミットして push する
  3. 再度プルリクエストを作成する
エラー: "Base ref must be a branch" 

ベースブランチが存在しない場合に発生します。

解決策:
git branch -r   # リモートブランチの一覧を確認

リモートに存在するブランチを確認して、そのブランチ名を –base で指定してください。

まとめ

GitHub CLIを使うことで、ブラウザを開かずにコマンドラインだけでプルリクエストを作成できます。

最初の認証さえ済ませば、その後は簡単なコマンドで完結します。