GitHub Integration

Available under the Integration Family: SCM

GitHub Integration is used to connect Shippable DevOps Assembly Lines platform to 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 this to your account integrations. This takes in Token value as input and gives you whatever level of access as 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.

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 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_TOKEN The Token used to connect to GitHub

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