Unify Integrations
Logo
Github

Github

Logo

4 mins READ

GitHub is a web-based platform for version control and collaboration, enabling developers to host, review, and manage code repositories. It simplifies teamwork with tools for branching, pull requests, and integration, fostering seamless software development workflows.

Authentication:

Integrating your application with GitHub revolutionizes development workflows and automation, facilitating efficient, secure, and collaborative software engineering solutions.  Before you begin, ensure you have the following information:

Connection Name : Choose a meaningful name for your connection. This name helps you identify the connection within your application or integration settings. It could be something descriptive like "MyAppGitHubIntegration".

Authentication Type : GitHub supports four types of authentication. They are :

  • Auth Token

  • OAuth with Client Credentials

  • OAuth 

  • GitHub App

Hostname:  Enter your GitHub Enterprise Server hostname. For example, github.example-organisation.com. Leave this field empty if you are using GitHub.com.

Auth Token Based:

  1. Log in to the GitHub website and click on your profile picture in the top right corner.

  2. Select "Settings" from the dropdown menu.

  3. In the left sidebar, click on "Developer settings".

  4. Click on "Personal access tokens" in the left sidebar.

  5. Click on "Generate new token" (for classic tokens) or "Generate new token (fine-grained").

  6. Enter a descriptive name for the token and optionally set an expiration date.

  7. Select the scopes/permissions you want to grant the token.

  8. Click "Generate token" at the bottom of the page.

  9. Copy the generated token immediately, as you won't be able to see it again after leaving the page.

  10. Treat this token like a password - keep it confidential and secure.

OAuth with Client Credentials Based: 

  1. Log in to the GitHub website and click on your profile picture in the top right corner.

  2. Select "Settings" from the dropdown menu.

  3. In the left sidebar, click on "Developer settings".

  4. Click on "OAuth Apps" in the left sidebar.

  5. Click on "New OAuth App".

  6. Enter a descriptive name, callback URL and all other required fields.

  7. Click "Register Application" at the bottom of the page.

  8. Copy the client ID next to Client ID in your app.

  9. Next to Client secrets, click "Generate a new client secret" to generate a client secret for your app.

  10. Copy the generated client secret and use these credentials for further authentication purposes.

OAuth Based :

  1. Click on the "Authorize button".

  2. You will be redirected to the permissions request screen.

  3. Carefully review the permissions we're asking for. If you're comfortable with the permissions, click "Authorize Integartions-Unifyapps" button.

  4. You will be automatically redirected back to our platform, and you should see a confirmation message that your Github account is now connected.

GitHub App Based :

  1. Log in to the GitHub website and click on your profile picture in the top right corner.

  2. Select "Settings" from the dropdown menu.

  3. In the left sidebar, click on "Developer settings".

  4. Click on "GitHub Apps" in the left sidebar.

  5. Click on "New GitHub App" and follow the official GitHub documentation to create an app.

  6. After creating the app, open your GitHub App settings and copy the App ID.

  7. Navigate to the Private keys section and click Generate a private key.

  8. Download or copy the generated private key.

  9. Install your app using the official GitHub documentation.

  10. Copy the installation ID in the app settings where the app is installed.

Actions

Action Name

Description

Compare two commits

Compares two commits against one another and returns the list of files changed between them

Create blob

Create a blob in the GitHub

Create comment

Creates a comment on an issue in GitHub

Create commit

Creates a new commit in GitHub

Create file

Create a new file in a repository in GitHub

Create issue

Creates a new issue in GitHub

Create pull request

Creates a new pull request in GitHub

Create pull request review comment

Create a review comment on a pull request

Create reference

Creates a reference in the GitHub

Create repository

Creates a new repository in a GitHub organization

Create tree

Creates a tree in the GitHub

Fetch labels

Fetches the labels defined in a GitHub repository.

Fetch milestones

Fetches the milestones defined in a GitHub repository.

Fetch organizations

Fetches the organizations the authenticated connection can access, plus a 'Your Repository' entry for the user's personal account.

Fetch repositories

Fetch repositories in Github

Get a repository

Gets a single GitHub repository's metadata (id, node_id, visibility, default_branch, etc.) by numeric repoId, or by owner + repo name.

Get commit

Gets a Git commit object from the GitHub

Get commit diff

Gets a Git commit object from the GitHub

Get directory content

Gets directory content from the GitHub Repository

Get file content

Gets file content from the GitHub Repository

Get issue

Gets an issue in GitHub

Get pull request (PR)

Gets details of a pull request (PR) in GitHub

Get raw file content

Gets raw file content from the GitHub Repository

Get reference

Gets a reference in the GitHub

Get User details

Get Github User details

Get workflow run

Retrieves a workflow run from Github

Iterate on repository files

Iterate on all files from the GitHub repository

List branches

Lists branches in GitHub repository

List collaborators with emails (GraphQL)

Lists a repository's collaborators with their emails (login, name, public email, org verified-domain emails) and repo permission, via the GitHub GraphQL API.

List commits

Lists commits on a repository branch within an optional time range

List pull request (PR) commits

Lists all commits associated with a pull request (PR) in GitHub

List pull request files

Lists all the files in a pull request

List repository collaborators

Lists collaborators for a GitHub repository, filterable by affiliation (direct, outside, all). Requires write, maintain, or admin access on the repository.

List statuses for ref

Lists commit statuses for a ref in Github

List workflow runs

Lists all workflow runs for a repository with optional filtering by branch, status, and event

Lists repositories

Lists repositories in Github

Search issues and pull requests

Searches issues and pull requests in Github

Trigger workflow

Triggers workflow in Github Repo

Update file

Updates a file in repository in GitHub

Update issue

Updates an issue in GitHub

Update reference

Updates a reference in the GitHub

Triggers

Trigger Name

Description

Iterate On All files in a github repo

Iterate on All Files from the GitHub Repository

New issue polling

Triggers when a new issue is created in GitHub

New issue polling

Triggers when a new pull request is created in GitHub

On Closed Issue Polling

Triggers when an issue is closed in GitHub

On new commits pushed

Triggers when new commits are pushed to a branch in GitHub

On new or updated issue

Triggers when a new or updated issue occurs in GitHub

On new or updated issue comment

Triggers when a new or updated issue comment is made in GitHub

On new or updated milestone

On new or updated milestone in a repository

On new or updated PR

Triggers when a new or updated pull request (PR) is made in GitHub

On new or updated PR review

Triggers when a pull request (PR) review activity is recorded in GitHub

On new or updated PR review comment

Triggers when a pull request (PR) review comment is created or updated in GitHub

On new or updated PR review thread

Triggers when a pull request (PR) review thread is created or updated in GitHub