kakudooo docs

heroku-review-apps-managerというgemを作った

Heroku Review Appsを使っていて、Review Appsの作成や削除に毎回Webブラウザの操作が必要になるのが煩わしかった。 ということで、CLIからReview Appsの基本的な操作ができるCLIツールを作って公開してみた。

heroku-review-apps-manager

本家からHeroku CLIというものが提供されているが、Review Appsの作成や削除まではできないため、Heroku Platform APIやGitHub APIを組み合わせてHerokuのDashboard相当の操作を実現する必要がある。 これらをCLIツールにしたのが、今回作ったgem。

使い方の例

README.mdにもセットアップ方法を記載しているが、一部補足を書いておく。

1. gemのインストール

gem install heroku-review-apps-manager

2. HerokuとGitHubそれぞれのAPIトークンを環境変数として設定する

https://dashboard.heroku.com/account

export HEROKU_REVIEW_APPS_MANAGER_HEROKU_API_KEY=heroku_api_key

https://github.com/settings/tokens

のスコープを付与する。

export HEROKU_REVIEW_APPS_MANAGER_GITHUB_TOKEN=github_token

direnvなどを使うと、プロジェクト毎に環境変数が設定できる。

.envrc

dotenv

.env

HEROKU_REVIEW_APPS_MANAGER_HEROKU_API_KEY=heroku_api_key
HEROKU_REVIEW_APPS_MANAGER_GITHUB_TOKEN=github_token
HEROKU_REVIEW_APPS_MANAGER_TARGET_GITHUB_REPOSITORY=org/repository # 例: kakudou3/heroku-review-apps-manager

3. Review Appsを操作する

例えば、Review Appsを作成したい場合。

heroku-review-apps-manager create_app Pipeline名 ブランチ名

おわりに

今回、初めてRubyでCLIツールの作成からgemの公開までをやってみたので、その手順については次のブログ記事に書こうと思っている。

改善要望があればお気軽にissueやPRをお待ちしています！

参考