コードを書く日々:フリーランスエンジニアの技術メモ

何度も同じことをググってしまう自分の備忘録です。何か調査した際には、そのエッセンスを記事としてまとめ、とりあえず共有することを心がけています。

GitHub CLIを使ってプルリクエストを作成する: gh pr create コマンド

GitHub CLIを使ってプルリクエストを作成する

GitHub CLIは、GitHubの操作をコマンドラインから行うことができる便利なツールです。

GitHub CLIgh pr createコマンドを使用して、プルリクエストを簡単に作成する方法をまとめます。

前提条件

  • GitHub CLIがインストールされていること
  • GitHubにログインしていること (gh auth login コマンドを使用)

プルリクエストの作成

gh pr create コマンドを使用して、新しいプルリクエストを作成します。基本的な使用方法は以下の通りです。

gh pr create --title "プルリクエストのタイトル" --body "プルリクエストの説明"

オプション

gh pr create コマンドには、プルリクエストの作成をカスタマイズするための複数のオプションがあります。

  • --title, -t: プルリクエストのタイトルを指定します。
  • --body, -b: プルリクエストの説明文を指定します。
  • --reviewer, -r: レビュアーを指定します。複数指定する場合は、カンマ区切りで指定します。
  • --assignee, -a: アサインするユーザーを指定します。複数指定する場合は、カンマ区切りで指定します。
  • --label, -l: ラベルを指定します。複数指定する場合は、カンマ区切りで指定します。
  • --draft: プルリクエストをドラフトとして作成します。

以下は、レビュアーとラベルを指定してプルリクエストを作成する例です。

gh pr create --title "新機能の追加" --body "新しい機能についての説明" --reviewer "user1,user2" --label "bug,enhancement"

このコマンドは、"新機能の追加" というタイトルと "新しい機能についての説明" という説明文でプルリクエストを作成し、user1とuser2をレビュアーとして指定し、bugとenhancementのラベルを付けます。

まとめ

GitHub CLIgh pr createコマンドを使用することで、プルリクエストの作成と管理が簡単になります。

詳細な情報はGitHub CLIのドキュメントやgh pr create --help コマンドで確認することができます。

cli.github.com