https://github.com/pdehaan/octokit-webhooks

Testing @octokit/webhooks for bot excellence.
https://github.com/pdehaan/octokit-webhooks

Last synced: 17 days ago
JSON representation

Testing @octokit/webhooks for bot excellence.

• Host: GitHub
• URL: https://github.com/pdehaan/octokit-webhooks
• Owner: pdehaan
• Created: 2020-05-01T04:51:42.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-12-16T00:54:15.000Z (about 1 year ago)
• Last Synced: 2024-10-31T13:11:57.582Z (2 months ago)
• Language: JavaScript
• Size: 7.81 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# octokit-webhooks

Testing @octokit/webhooks for bot excellence.

## SETUP

1. Clone repo and set your `GH_WEBHOOK_SECRET` and `PORT` environment variables in a .env file.

2. Deploy your server to The Cloud(tm) or test locally using something like ngrok (to start your proxy server locally on port 80, use ./ngrok http 80). If you're using ngrok, don't forget to also start your Node service locally using node gh-bot.

3. Go to your `https://github.com///settings/hooks` settings and click the "Add webhook" button.

4. Set your "Payload URL" to your deployed server or ngrok tunnel URL.

5. Set your "Content type" to "application/json".

6. Type/paste in the GitHub webhook secret that you set in your .env file above.

7. Select the events you want to trigger the webhook; in our case it will just be "Issues", but feel free to get a little silly with it.

8. When you're done, click the "Add webhook" button.

9.  If you get a delivery error, keep hacking and click the "Redeliver" button to retry. If you're using ngrok, there is a handy web interface on http://127.0.0.1:4040 that is useful for debugging requests and received payloads.