Pull Reminders requires a GitHub App in order to integrate with your GitHub Enterprise instance. Follow the steps below to create a GitHub App. You'll also come back later to update some settings after your Pull Panda instance is running.
1. In your GitHub instance, go to "Settings", then "Developer Settings", then "GitHub Apps", then click "New GitHub App".
2. Set the fields, permissions, and webhook subscriptions outlined below. You can always change these later after saving. Note that several of these settings include your Pull Reminders instance hostname, so if you don't know it yet be sure to come back later and update your settings.
Fields:
GitHub App name: Pull RemindersUser auth callback: http://pullreminders.myco.com/auth/github/callbackSetup URL: http://pullreminders.myco.com/installsWebhook URL: http://pullreminders.myco.com/github_webhooks
Permissions:
Issues: Read-onlyRepository metadata: Read-onlyPull requests: Read-onlyOrganization members: Read-only
Events (the Member
option is not available for earlier versions of GitHub Enterprise):
Issue CommentIssuesPull requestPull request reviewPull request review commentMemberMembershipOrganizationRepository
3. After saving your GitHub App, set your app icon to our provided image and then generate a private key. You should also see OAuth credentials and your app ID. You'll use this information along with your private key in the next section.
4. Go to the "Advanced" tab and click the "Make public" button at the bottom. This allows Pull Reminders to be used and installed by all users of your GitHub Enterprise instance.
5. Though not required, it is recommended that you transfer ownership of the GitHub App to a superuser or organization so that the app isn't deleted if your individual GitHub account is deactivated. To do this, go under the "Advanced" tab and click the "Transfer ownership" button at the bottom.