クエリパラメータを使ってお手軽にGitHubのプルリクを作成する

ワンクリックくらいの気持ちで手軽にPRを作成できる方法が分かったので、忘れないようにメモ。

どんなときに使えるのか?

そこそこな頻度で定型的なPRを作成する場合に便利。
具体例としては、評価環境や本番環境へデプロイするために、定型的なPRを作成する必要がある場合。

プルリク作成用のURLとしてブックマークすると便利かもしれない。

例1:プルリクテンプレートを指定してPRを作成する

以下のようなプルリク作成を想定します。

  • リポジトリの所有者名: octo-org
  • リポジトリ名: octo-repo
  • ベースブランチ(マージ先): production
  • ヘッドブランチ(マージ元): main
  • プルリクテンプレートのファイル名: release.md

以下のURLへアクセスすると、ワンクリックでプルリク作成できる画面へ飛べます。

https://github.com/octo-org/octo-repo/compare/production...main?quick_pull=1&template=release.md

例2:プルリクテンプレートを使わず、直接パラメータで指定する

特に便利だなーと思ったのはこちら。
プルリクテンプレートを用意していなくても、クエリパラメータでタイトルや本文を直接指定できます。

プルリクテンプレートを使おうとするとかえってハードルが高くなりそうな場合は、試す価値があるかも。

  • リポジトリの所有者名: octo-org
  • リポジトリ名: octo-repo
  • ベースブランチ(マージ先): production
  • ヘッドブランチ(マージ元): main
  • PRのタイトル: 本番環境へデプロイ
  • PRの本文: mainブランチの内容をリリースします
https://github.com/octo-org/octo-repo/compare/production...main?quick_pull=1&title=本番環境へデプロイ&body=mainブランチの内容をリリースします

公式ドキュメント

クエリパラメータについては、以下が公式ドキュメント。
https://docs.github.com/ja/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/using-query-parameters-to-create-a-pull-request

クエリパラメータにquick_pull=1ではなくexpand=1を指定しても同じ挙動をするように見える。
が、expandというパラメータは公式ドキュメントには記載がないので、quick_pull=1を使うのがよさそう。

関連記事


  1. 他の人には読めない形式でGitHubのSecretsの値を読み出す
  2. GitHub Actionsでプルリクのコメントに複数行テキストを投稿する
  3. GitHub Actionsでエラーの時だけ特定の処理を実行する
  4. Tera Termのマクロで、パスワードを扱う操作を自動化する
  5. HugoテンプレートをOGPやTwitter Cardsに対応する
  6. 既存コードへのCheckstyle導入におけるルールの選定
  7. Checkstyleで汎用的に使えそうなルールをピックアップしてみた

comments powered by Disqus