デプロイとか動かすのに必要なことをREADMEに書く

[knokmki612]

oss-gate/retrospective#119

書く内容をここでメモる

[knokmki612]

1. 必要な環境変数
2. デプロイ周り
3. ローカルでの動かし方
4. GitHub Appで必要な権限

あたりが必要

[knokmki612]

.env.exampleを見れば必要な環境変数は分かる。

• APP_ID: GitHub App
• WEBHOOK_SECRET: GitHub App
• WEBHOOK_PROXY_URL: ローカルはsmee.io、本番はnow.sh
• DOORKEEPER_TOKEN: Doorkeeper API

[knokmki612]

now.jsonがデプロイの設定

now-cliは環境変数を.envに書かずにnow-cliで管理する方法があるのでそれを使っている。

cronするものなので1つしかインスタンスを使わないようにしている。

実はGitHubリポジトリとnowを連携したらpushでデプロイしてくれるけど現状は手動でデプロイしてる。

あと、nowのv1で動かしているけどサーバレスなv2に将来的には移行する必要がある。

[knokmki612]

ローカルで動かす時

probot-create-appするとsmee.ioでwebhookに使えるurlが発行されるけど、それ以外だと自分で発行する必要がある

あとは環境変数を用意して npm start すればいい

[knokmki612]

GitHub Appの権限

issuesだけ

そういえばGitHub Appで使っている鍵(多分create-probot-appしたときのやつ)を紛失している…いずれにしても鍵を作ってGitHub Appの設定で指定する手順も書くべき

[knokmki612]

github actionsに移行したので、このリポジトリのものを動かすのに必要な手順はだいぶ簡略化されている。

ドキュメントとして必要なのは、もうけているcore.inputの説明。 DOORKEEPER_GROUP など