git-pr-releaseについて

※2021年8月13日にgithubパスワード認証が廃止になったことに伴い、
セットアップ方法が少し変わったので、改めてこちらに記事を書きました。
https://www.fuwamaki.com/article/187

gitを用いてgitflowで開発しているチームで、
リリース時に develop -> master マージ作業をするとき、
git-pr-releaseを用いると、いい感じのPullRequestを自動で作ってくれます。

git-pr-releaseのインストール

$ gem install git-pr-release

※gemは事前にできるようにしておいてください。

要注意！！

最新バージョン0.8.0ではgit-pr-releaseが動作しない模様！
https://github.com/motemen/git-pr-release

実行しても、エラーもなにも起きない、という事態が発生します。
バージョン0.6.0で動作問題なく確認できてるので、バージョン指定してインストールしましょう。

$ gem install git-pr-release -v "0.6.0"

SEO用: 動かない 動作しない コケる

git-pr-releaseの設定

対象リポジトリに .git-pr-release ファイルを作成、下記を記載。
.git/config に書いてもいいみたいです。
この場合だと、 develop -> master へのPullRequestとなります。

[pr-release "branch"]
  staging = develop
  production = master
[pr-release]
  template = .git-pr-template

git-pr-templateの作成

PullRequestに記載するテンプレートを作成します。
この手順は必須ではありませんが、テンプレートがあったほうが便利なので記載します。

対象リポジトリに .git-pr-template ファイルを作成、下記を記載。

Release <%= Time.now.strftime("%Y-%m-%d") %>
<% pull_requests.each do |pr| -%>
<%= pr.to_checklist_item %>
<% end -%>

- - - 

### リリース作業

- [ ] xxx
- [ ] xxx
- [ ] xxx

これで、リリースタイトルが Release 20xx-xx-xx で、
developにマージされたPullRequestの一覧が載るテンプレートになります。

git-pr-releaseを実行

$ git-pr-release

UserIDとPasswordを聞かれたら、GitHubのUserIDとPasswordを入力します。

-> これでいい感じのPullRequestが、いい感じに作れます。

より細かい設定・利用をしたい方は、git-pr-releaseのGitHubを参照。
https://github.com/motemen/git-pr-release