Skip to content

[reg-notify-github-plugin] Feature Request for IP Allowlist Support #720

Description

@south-mer

Is your feature request related to a problem? Please describe.

The reg-suit GitHub App's server does not have an IP allowlist configured, so it is blocked if IP allowlist on GitHub is enabled.

Describe the solution you'd like

We would like your help to configure your GitHub App reg-suit, so the app would be compatible with GitHub’s organization/enterprise-level IP allowlist.

This setting can only be configured by the owner of the app (in this case, reg-viz), and cannot be configured by organization owners who have the app installed on their organization. It should take about 5 minutes, and does not affect any organizations without IP allowlist using your app.

In the "Additional context" section, there are minimal instructions on how this change can be performed, for your reference. Alternatively, you can also refer to the Managing allowed IP addresses for a GitHub App documentation page by GItHub.

Describe alternatives you've considered

  • Use the reg-notify-github-with-api-plugin instead: it seems that this plugin is not recommended for github.com, but might be usable.
  • Allowlist the server used by reg-notify-github-plugin: the server does not have a static egress IP.

Additional context

Instruction on Configuring IP Allowlist for GitHub Apps

Step 1: Confirm the Egress IP List

If you already have a list of IP (or IP ranges) that your app accesses GitHub from, please prepare the list.

Otherwise, you can proceed to step 2 and use the IP range 0.0.0.0/0, which is the range of all IPv4 addresses.

(Please note that step 2 will only configure the IP allowlist for your app’s access to GitHub, and does not affect other access to GitHub for organizations with IP allowlist, so there is no need to minimize the list here.)

Step 2: Open the GitHub App’s Setting Page

For apps owned by a personal account,

For apps owned by an organization,

  • Go to your organization’s GitHub page,
  • Go to the “Settings” tab,
  • On the side bar select “Developer settings” > “GitHub Apps”, and
  • Click “Edit” for the GitHub App

Step 3: Edit the IP Allowlist

Enter each IP prepared in "Step 1: Confirm the Egress IP List", and click “Add”.

Image

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions