Skip to main content

Connect with GitHub

Our integration with GitHub allows you to sync repositories to Venue.sh as entities.

Prerequisites
  • An existing organization in Venue.sh
  • A role of Owner or above
  • A Github account or organization with an Owner permission level

Creating a Personal Access Token​

As a best practice, we recommended setting up a dedicated service account for this token.

note

GitHub's documentation describes the token-creation process in detail. While we endeavour to keep this document current, GitHub's process may have changed.

  1. Go to https://github.com and sign in.

  2. Click your profile pic, then select Settings > Developer Settings > Personal Access Tokens > Tokens (classic).

tip

Here's a shortcut if you want to save some clicks.

  1. Click the Generate new token dropdown, then select Generate new token (classic).

  2. Give the token a name and define its expiration period.

tip

Remember, when the token expires, you will need to replace it to ensure no lapse in functionality.

  1. Choose the following scopes/permissions for the token:

    • repo
      • repo:status
      • repo_deployment
      • public_repo
      • repo:invite
      • security_events
    • workflow
    • admin:org
      • read:org
    • user (required to receive webhook changes from GitHub):
      • read:user
      • user:email

  2. Click Generate token.

  3. Take note of the personal access token as it cannot be retrieved once you leave the page.

Creating an OAuth app​

To fully integrate GitHub with Venue.sh, you must set up an OAuth app.

  1. Go to https://github.com/settings/organizations and sign in.
  2. Ensure your desired organization is selected, then click Settings.
  3. Scroll to the bottom of the left menu, then click Developer Settings > OAuth Apps.
  4. Click on New Oauth App, and insert the following properties:
  • Application name: Venue.sh
  • Homepage URL: https://<organization>.venue.sh
  • Callback URL: https://<organization>.venue.sh/api/auth/github/handler/frame
tip

Your organization's Homepage URL and Callback URL can be found on the right-hand sidebar in the Venue.sh app when adding a Github connection.

  1. Click Register Application.
  2. Click Generate a Client Secret.
  3. Take note of the Client ID and Client secret values.