GitHub Enterprise Integration

Available under the Integration Family: SCM

GitHub Enterprise Integration is used to connect Shippable DevOps Assembly Lines platform to your instance of GitHub Enterprise Server.

You can create this from the integrations page by following instructions here: Adding an account integration.

This is the information you would require to create this integration:

  • Name -- friendly name for the integration
  • URL -- location of your GHE server API. The format is in https://(GitHub Enterprise URL)/api/v3
  • Token -- personal access token with the right levels of permission

Resources that use this Integration

Resources are the building blocks of assembly lines and some types of resources refer to integrations by their names. The following resource types can be created with a GitHub Enterprise integration.

Default Environment Variables

When you create a resource with this integration, and use it as an IN or OUT for a job that can execute user defined scripts, a set of environment variables are configured by the platform that may be useful to set the context before user defined scripts execute as part of the job. These variables are available when a resource with this integration type is used.

<NAME> is the the friendly name of the resource.

Environment variable Description
<NAME>_INTEGRATION_URL GitHub Enterprise API location
<NAME>_INTEGRATION_TOKEN The Token used to connect to GitHub Enterprise

Shippable Utility Functions

To make it easy to use these environment variables, the platform provides a command line utility that can be used to work with these values.

How to use these utility functions is documented here.

Further Reading