👋

VSCodeでgithubのプルリクエストを作成する:GitHub CLI編

2023/01/18に公開約1,600字

はじめに

VSCodeを利用してZennの記事執筆を始め、日々効率化の改善を続ける毎日です。
今回はVSCode上でgithubのプルリクエスト作成できるようにしたので記事にします。

背景

githubを使った運用として、記事ごとにプルリクエストを作成しています。
https://zenn.dev/haoblackj/articles/manuscript_compare_by_pr

とりあえずトピックを見つけたら記事の下書きを作ってプルリクエストを作成、アイデアや参考記事をコメントやissueにまとめる形で管理しています。

githubのプルリクエスト作成はgit cliでカバーしていないので、わざわざブラウザを開いてプルリクエスト作成やマージをしていたのでいい加減効率化することにしました。

GithubCLIを利用した場合とVSCodeの拡張機能を利用した方法のどちらもあるので今回はCLIを利用した方法を紹介します。

GithubCLIの利用方法

  1. インストール
    GithubCLIは文字通りgithubの機能をCLIで提供します。

https://cli.github.com/

こちらのサイトからインストーラをダウンロードしてインストールするか、以下のコマンドからインストールします。

windows(winget)の場合
winget install --id GitHub.cli	

OSによっても異なるので各自こちらの環境から必要なコマンドを探してください。
https://github.com/cli/cli#installation

  1. 認証
    インストールしたらgithubの認証を済ませます。
    まずはターミナルで以下コマンドを叩いてログインを行います。
gh auth login

https://cli.github.com/manual/gh_auth_login

すると以下の通りログインする環境と方法を確認されるので適宜好ましいものを選びます。

? What account do you want to log into?
? What is your preferred protocol for Git operations?
? Authenticate Git with your GitHub credentials?
? How would you like to authenticate GitHub CLI?

私の場合はブラウザを利用してログインを選択したので、このままブラウザでgithubが開き、ワンタイムパスワードで認証する流れでした。

  1. プルリクエスト作成
    認証が完了したらプルリクエスト作成をコマンドで叩けるようになります。

プルリクエスト作成は以下のコマンドから実行できます。

gh pr create [flags]

オプションは以下を参照してください。
https://cli.github.com/manual/gh_pr_create

コマンドを叩くと作成するプルリクエストの情報を聞かれるので適当なものを応えれば完了です。

? Title
? Body
? What's next?

簡単。

参考にさせていただいたサイト

https://cli.github.com/
https://cli.github.com/manual/gh
https://github.com/cli/cli#installation
https://zenn.dev/hankei6km/articles/pull-request-with-github-cli
https://zenn.dev/haoblackj/articles/manuscript_compare_by_pr

Discussion

ログインするとコメントできます