Connect with Github

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

Note: 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 Github

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.

Go to https://github.com and sign in.
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.
Click the Generate new token dropdown, then select Generate new token (classic).
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.
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
Click Generate token.
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.

Go to https://github.com/settings/organizations and sign in.
Ensure your desired organization is selected, then click Settings.
Scroll to the bottom of the left menu, then click Developer Settings → OAuth Apps.
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.
Click Register Application.
Click Generate a Client Secret.
Note the Client ID and Client secret values.