Cloud customer?
Start for Free >
Upgrade in MyJFrog >
What's New in Cloud >

Search





The GitHub Integration is used to connect the JFrog Pipelines platform to GitHub. 

Creating an 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 -- your GitHub API endpoint. This is already hard-coded to https://api.github.com
  • Token -- your  GitHub personal access token with the permissions needed to run your jobs

    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.


Page Contents

Usage

The GitHub integration can be used in the GitRepo resource.

The GitHub 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 it, a set of environment variables is automatically made available.

Environment variable

Description

res_<resource-name>_gitProvider_urlGitHub API location
res_<resource-name>_gitProvider_tokenThe Token used to connect to GitHub


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

Environment variableDescription
int_<integration-name>_urlGitHub API location
int_<integration-name>_tokenThe Token used to connect to GitHub
  • No labels
Copyright © 2021 JFrog Ltd.