Create a GitHub App for Custom Configuration

Log in to GitHub as an owner or administrator.

Select the organization or account where you want to create the app.

Choose the installation scope for the app:

• All repositories: The app will have access to all current and future repositories in the organization.

• Only select repositories: The app will have access only to repositories you select.

Navigate to Settings > Developer settings > GitHub Apps > New GitHub App.

Configure the app:

• GitHub App name: Enter a name (cannot start with "GitHub").

• Homepage URL: Enter your organization's URL or any valid URL (for example, https://localhost).

• Callback URL: Enter the callback URL provided in the wizard.

• Enable the Redirect on update checkbox to ensure the callback URL is used when updating app settings.

Select the scope:

• Only on this account: The app is private to your account or organization.

• Any account: The app is public and can be installed on any account.

Select the required scopes:

• Repository Permissions

  • Administration (Read & Write)

  • Commit Statuses (Read & Write)

  • Contents (Read & Write)

  • Custom Properties (Read & Write)

  • Metadata (Read Only)

  • Pull Requests (Read & Write)

  • Webhooks (Read & Write)

  • Workflow (Read & Write)

    • Required for pushing changes to workflow files in the .github/workflows/ directory

• Organization/Account Permissions

  • Members (Read Only)

  • Plan (Read Only)

Click Create GitHub App.

Obtain the credentials:

a. Copy the Client ID.

b. Click Generate a new client secret and copy the Client Secret.

c. Scroll down to Private keys and click Generate a private key. Download the .pem file.

Log in to GitHub as an owner or administrator.

Select the organization or account where you want to create the app.

Choose the installation scope for the app:

• All repositories: The app will have access to all current and future repositories in the organization.

• Only select repositories: The app will have access only to repositories you select.

Navigate to Organization Settings > Developer settings > GitHub Apps > New GitHub App.

Configure the app:

• GitHub App name: Enter a name (cannot start with "GitHub").

• Homepage URL: Enter your organization's URL or any valid URL (for example, https://localhost).

Callback URL: Enter the callback URL provided in the wizard.

• Enable the Redirect on update checkbox to ensure the callback URL is used when updating app settings.

Select the scope:

• Only on this account: The app is private to your account or organization.

• Any account: The app is public and can be installed on any account or organization.

Select the required scopes:

• Repository Permissions

  • Administration (Read & Write)

  • Commit Statuses (Read & Write)

  • Contents (Read & Write)

  • Custom Properties (Read & Write)

  • Metadata (Read Only)

  • Pull Requests (Read & Write)

  • Webhooks (Read & Write)

  • Workflow (Read & Write)

    • Required for pushing changes to workflow files in the .github/workflows/ directory

• Organization/Account Permissions

  • Members (Read Only)

  • Plan (Read Only)

Click Create GitHub App.

Obtain the credentials:

a. Copy the Client ID.

b. Click Generate a new client secret and copy the Client Secret.

c. Scroll down to Private keys and click Generate a private key. Download the .pem file.