🤖

GitHub CLIのAliasを活用してPull Request作成にかかる時間を短縮する

2024/09/10に公開

はじめに

業務でGitHubを使用していて、Pull Requestの作成時にReviewerの指定やAssigneeの指定、Base Branchなどポチポチ入力するのが面倒なことがある。
それならgit pushのタイミングで全部やってしまいたくなり、GitHub CLIのgh pr creategh aliasの合わせ技で解決することにした。

前提

  • 変更の内容や時期によってReviewer/Milestone/Base Branchが変わる
  • Pull Requestの本文はプロジェクトとして指定されたテンプレートに沿って記載する運用にしている

Aliasの作成

gh alias set autopr 'pr create --body-file docs/pull_request_template.md --assignee @me --reviewer $1 --milestone $2 --base $3 --draft'

使用例

gh autopr reviewer1,reviewer2(,..) milestone_name target_branch

実行すると、Titleの入力などが求められるので、内容に沿って入力する。
処理が完了すると、予め下記のように設定されたDraftのPull Requestが作成される。

  • テンプレート: docs/pull_request_template.md
  • Reviewer: reviewer1 / reviewer2 (/ ..)
    • カンマ区切りで複数指定可能
  • Assignee: 自分
  • Milestone: milestone_name
  • Base Branch: target_branch

本文はブラウザ等でテンプレートに沿って記入し、支障なければOpenする。

参考

Discussion