Add .env.example template info
#414
Conversation
Add `.env.example` template info
|
Thanks for opening this pull request! Please check out our contributing guidelines. |
|
Thanks for the PR! What would you think about updating https://github.com/probot/create-probot-app to copy https://github.com/probot/create-probot-app/blob/master/bin/create-probot-app.js#L122-L130
|
|
@bkeepers that's an even better idea, so I've rewritten it. What do you think? |
docs/development.md
Outdated
| @@ -56,7 +56,7 @@ The most important files note here are `index.js`, which is where the code for y | |||
|
|
|||
| To run your app in development, you will need to configure a GitHub App to deliver webhooks to your local machine. | |||
|
|
|||
| 1. Go to [smee.io](https://smee.io) and click **Start a new channel**. Set `WEBHOOK_PROXY_URL` in your `.env` to the URL that you are redirected to (you can use `.env.example` as a template). | |||
| 1. Go to [smee.io](https://smee.io) and click **Start a new channel**. On your local, copy `.env.example` to `.env`, then set `WEBHOOK_PROXY_URL` to the URL that you are redirected to. | |||
There was a problem hiding this comment.
Should this be "On your local machine"?
|
Sorry, just to clarify, I was suggesting we update |
|
@bkeepers That's fair and an easier way to do it. For further clarity, should we still keep the cc @JasonEtco ^ |
Actually now that you bring it up, the doc change here might be the better solution because it works whether you were the person that ran 🤔 What do you think? |
|
Thanks for your contribution to probot! 🎉 |
|
Thanks @allthedoll for this, and sorry for the back and forth. I made a few tweaks and merged it. |
* origin/master: (32 commits) fix(package): Update bottleneck to the latest version 🚀 (#397) Use npx, document yarn (#417) doc: Add `.env.example` template info (#414) Further explicit note on yml config for target repos (#416) fix(package): update dotenv to version 5.0.0 (#412) Payload object explanation in documentation (#411) More explicit notes on yml config for target repos (#415) fix(package): update @octokit/rest to version 14.0.8 refactor: github -> @octokit/rest chore(console): github is now octokit test: adapt for @octokit/rest fix(package): -github, +@octokit/rest Allow setting logger name to separate components (#355) Improve docs on `probot simulate` command (#405) docs: Add "next" front matter (#406) chore(package): update semantic-release to version 12.2.2 (#395) docs: Add docs for data persistence (#242) Add section on how to help if you're just starting out (#393) Remove unused eventsource, move jest to dev deps (#403) fix: update log when server starts #394 (#398) ...
This pull request adds a note about the
.env.examplefile that can be used as a template when following Configure a GitHub App to set theWEBHOOK_PROXY_URL.Original issue: probot/friction#20