GitHub Enterprise Integration

JFrog Pipelines Documentation

Products
JFrog Pipelines
Content Type
User Guide
ft:sourceType
Paligo

The GitHub Enterprise Integration is used to connect JFrog Pipelines to your instance of GitHub Enterprise Server.

Creating a GitHub Enterprise Integration

You can add this integration by following steps on the Managing Pipelines Integrations page.

Here is the information you need to create this integration:

  • Name -- choose a friendly name for the integration

  • url -- location of your GHE server API. The format is https://(GitHub Enterprise URL)/api/v3

  • Token -- your GitHub personal access tokenwith the permissions needed to run your job

    Token permissions

    To use this integration as a pipeline source, your token must be granted these permissions at minimum:

    • repo (all)

    • admin:repo_hook (read, write)

    • admin:public_key (read, write)

    Additionally, if your organization uses SAML single sign-on, you will need to authorize your token.

Usage

The GitHub Enterprise integration can be used in the GitRepo resource.

The GitHub Enterprise integration can also be added directly to a step in the integrations section.

Default Environment Variables

When you create a resource with this integration, and create a step that uses the resource, a set of environment variables is automatically made available.

Environment variable

Description

res_<resource-name>_gitProvider_url

GitHub Enterprise API location

res_<resource-name>_gitProvider_token

Token used to connect to GitHub Enterprise

When you add this integration directly to a step, a set of environment variables is automatically made available.

Environment variable

Description

int_<integration-name>_url

GitHub Enterprise API location

int_<integration-name>_token

Token used to connect to GitHub Enterprise