Skip to content

Commit c2e890b

Browse files
authored
Update deploy.md heroku settings
With the correct webhook url in the github app and 2 more optional settings
1 parent 784fb19 commit c2e890b

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

docs/deploy.md

+10-6
Original file line numberDiff line numberDiff line change
@@ -205,24 +205,24 @@ Probot runs like [any other Node app](https://devcenter.heroku.com/articles/depl
205205
206206
1. Make sure you have the [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli) client installed.
207207
208-
1. Clone the app that you want to deploy. e.g. `git clone https://github.com/probot/stale`
208+
2. Clone the app that you want to deploy. e.g. `git clone https://github.com/probot/stale`
209209
210-
1. Create the Heroku app with the `heroku create` command:
210+
3. Create the Heroku app with the `heroku create` command:
211211
212212
$ heroku create
213213
Creating arcane-lowlands-8408... done, stack is cedar
214214
http://arcane-lowlands-8408.herokuapp.com/ | [email protected]:arcane-lowlands-8408.git
215215
Git remote heroku added
216216
217-
1. Go back to your [app settings page](https://github.com/settings/apps) and update the **Webhook URL** to the URL of your deployment, e.g. `http://arcane-lowlands-8408.herokuapp.com/`.
217+
4. Go back to your [app settings page](https://github.com/settings/apps) and update the **Webhook URL** to the "${URL_of_your_deployment}/api/github/webhooks", e.g. `http://arcane-lowlands-8408.herokuapp.com/api/github/webhooks`.
218218
219-
1. Configure the Heroku app, replacing the `APP_ID` and `WEBHOOK_SECRET` with the values for those variables, and setting the path for the `PRIVATE_KEY`:
219+
5. Configure the Heroku app, replacing the `APP_ID` and `WEBHOOK_SECRET` with the values for those variables, and setting the path for the `PRIVATE_KEY`:
220220
221221
$ heroku config:set APP_ID=aaa \
222222
WEBHOOK_SECRET=bbb \
223223
PRIVATE_KEY="$(cat ~/Downloads/*.private-key.pem)"
224224
225-
1. Deploy the app to heroku with `git push`:
225+
6. Deploy the app to heroku with `git push`:
226226
227227
$ git push heroku master
228228
...
@@ -231,12 +231,16 @@ Probot runs like [any other Node app](https://devcenter.heroku.com/articles/depl
231231
-----> Launching... done
232232
http://arcane-lowlands-8408.herokuapp.com deployed to Heroku
233233
234-
1. Your app should be up and running! To verify that your app
234+
7. Your app should be up and running! To verify that your app
235235
is receiving webhook data, you can tail your app's logs:
236236
237237
$ heroku config:set LOG_LEVEL=trace
238238
$ heroku logs --tail
239239
240+
8. SSL [Optional]: If you want to secure webhook payloads, go to Heroku app settings => Configure SSL => Automatic Certificate Management (ACM) which uses Let's encrypt (or upload your own). Then go to the GitHub app settings, and update the url to use https:// instead
241+
242+
9. Cron [Optional]: You can configure this app to run on a schedule using the var (CRON), you can set it in the app settings in the UI, or using `heroku config:set CRON='0 * * * *'` to run every hour for ex.
243+
240244
## Create the GitHub App
241245
242246
Every deployment will need an [App](https://developer.github.com/apps/).

0 commit comments

Comments
 (0)