GitHub Enterprise Integration

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

Creating an Account Integration

You can add this account integration by following steps on the Adding an account integration page.

Here is the information you need to create this integration:

  • Integration type -- GitHub Enterprise
  • Name -- choose a 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

Usage in Assembly Lines

The GitHub Enterprise integration can be used in the following resources:

Default Environment Variables

When you create a resource with this integration, and use it as an IN or OUT for a runSh or runCI job, a set of environment variables is automatically made available that you can use in your scripts.

<NAME> is the the friendly name of the resource with all letters capitalized and all characters that are not letters, numbers or underscores removed. Any numbers at the beginning of the name are also removed to create a valid variable. For example, my-key-1 will be converted to MYKEY1, and my_key_1 will be converted to MY_KEY_1.

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

Shippable Utility Functions

The platform also provides a command line utility called shipctl that can be used to retrieve the values of these environment variables.

The specific function that can be used in the jobs yml is: shipctl get_integration_resource_field <resource name> <field name>.

Here is a table that provides the mapping from the environment variable to the field name.

Environment variable Field Name
<NAME>_INTEGRATION_URL url
<NAME>_INTEGRATION_TOKEN token

More information on other utility functions is documented here.

Further Reading