Instructions for Creating a GitHub App Incorrect

[ngamradt-turner]

Describe the bug

The documentation here...

https://github.com/github-community-projects/private-mirrors/blob/main/docs/developing.md#github-app

...notes that you should set your Webhook URL to...

http://localhost:3000/api/webhooks

...however, when I try to do that, I get the following error...

Webhook URL is not supported because it isn't reachable over the public Internet (localhost)

To Reproduce

1. Follow the instructions on this page:
   • https://github.com/github-community-projects/private-mirrors/blob/main/docs/developing.md#github-app
2. When you try to save the webhook, you receive a notice that the webhook must be reachable over the public Internet.
3. You cannot save the webhook, so you cannot move on with local development.

Expected behavior

1. Follow the instructions on this page:
   • https://github.com/github-community-projects/private-mirrors/blob/main/docs/developing.md#github-app
2. When you try to save the webhook, you are able to save successfully.
3. You are able to continue with local development.

Screenshots

Here is a screenshot of the error:

Additional context

Though this error makes sense to me, it leaves me wondering if these instructions ever worked. It would be good if the instructions suggest the best way to work around this issue.

[ngamradt-turner]

@zkoppert - I have not created a GitHub App before and I appear to be having trouble getting the correct settings. Do you have an example of a working .env file? Reaching out to you as you helped with my last ticket.

Obviously I would want secret values blurred and all, but just curious what a minimal setup looks like.

[ahpook]

Hi @ngamradt-turner thanks for giving this a try, sorry you are running into trouble. This has definitely worked in the past but I haven't deployed this way in a while (mostly using an Azure instance) so I'll have to dig in and figure out what changed.

[ngamradt-turner]

@ahpook , thanks for the reply. I was able to get this working with https://smee.io. I think I took screenshots. If I can find time, I could try to submit an example.