Follow these steps to set up your GitHub app:
Registering Your GitHub App
- Access Developer Settings:
- Click on your profile photo in the upper-right corner of GitHub.
- Go to
Settings
and then click onDeveloper settings
in the left sidebar.
- Create a New GitHub App:
- Under
Developer settings
, selectGitHub Apps
and click onNew GitHub App.
- Under
- Provide App Details:
- Enter the following details for your app:
- GitHub App name: Choose a name for your app.
- Homepage URL: Specify the URL of your app (e.g., repository URL - github.com/[Your GitHub User ID]/kaizen/).
- Webhook URL: Enter the server URL where webhook requests will be sent.
- Optionally, set a Webhook secret for request validation.
- Enter the following details for your app:
Configure Webhook and Permissions
- Activate Webhook:
- Ensure the "Webhook" toggle is set to
Active.
- Ensure the "Webhook" toggle is set to
- Set Permissions:
- In the sidebar, navigate to
Permissions & events.
- In the sidebar, navigate to
- Define Permissions:
- Under
Repository permissions
,Organization permissions
, andAccount permissions
, select required permissions such as:- Repository Content
- Pull Request
- Metadata
- Check Runs
- Under
Subscribe to Events
- Choose Events:
- Under
Subscribe to Events
, select the webhook events your app needs to receive (e.g., "Pull request" events).
- Under
By following these steps, your GitHub app will be properly configured with the necessary permissions and event subscriptions for your project.