GitHub Integration

The GitHub Integration is used to connect Shippable DevOps Assembly Lines platform to GitHub. There are 3 ways in which this type of integration can be added:

  • You sign in to Shippable with GitHub credentials. In this case, we automatically set up an Account Integration named github for you. This integration is the default one that we use when you enable CI projects for your repositories and sync your permissions with GitHub.
  • Second, you can manually add an integration by following instructions in the Creating an integration section below. This takes in Token value as input and gives you whatever level of access the token has.
  • Third, if you used another method of signing into Shippable, then from your Account Profile you can connect your GitHub account to have multi-provider login to your account.

Creating an Integration

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

Here is the information you need to create this integration:

  • Integration type -- GitHub
  • 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 token with the permissions needed to run your jobs

Usage in Assembly Lines

The GitHub 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 API location
<NAME>_INTEGRATION_TOKEN The Token used to connect to GitHub

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