Pipelines for Applications

GitHub is a software repository hosting service that provides revision control and source code management.

Integrating GitHub with Pipelines provides continuous integration and continuous deployment.

With GitHub integration you can create applications in Pipelines from a GitHub repository and enable auto-builds when a change is checked into the repository.

Integrate with GitHub

Before beginning, ensure you are using the correct user account in Puppet Pipelines.

To enable GitHub integration, follow these steps.

  1. In the Pipelines web UI click the gear icon at the top right.
  2. Click the Integrations link on the left.
  3. Click the GitHub icon.
  4. Click the Connect GitHub Account button.
  5. At this point, your browser will be directed to Gibhub for you to authorize Pipelines. If you are not already logged into Gibhub, you will be prompted to.

  6. Authorize Pipelines in GitHub.

Integrate GitHub Enterprise

With GitHub Enterprise integration you can create applications in Pipelines from a GitHub Enterprise repository and enable auto-builds when a change is checked into the repository.

Before beginning, ensure you are using the correct user account in Puppet Pipelines.

To enable GitHub Enterprise integration, follow these steps.

  1. In the Pipelines web UI click the gear icon at the top right.
  2. Click the Integrations link on the left.
  3. Click the GitHub Enterprise button.
  4. At this point you will have to login to your GitHub Enterprise account and create a Personal Access Token.
  5. Login to your GitHub Enterprise instance.
  6. Click your profile icon on the top right.
  7. Select Settings from the drop down.
  8. In the left menu, click the Personal access tokens link.
  9. Click the Generate new token button.
  10. Ensure the following options are set:
  • repo
  • Access private repositories.

  • user:email
  • Access user email address (read-only).

  • read:org
  • Read org and team memberships.

  • Click Generate token button.
  • It is important you copy the token now as it will not be visible again.
  • Return to Pipelines.
  • Enter your GitHub Enterprise Host/IP.
  • Enter the GitHub Enterprise Personal Access Token you just created.
  • Click the Add Credentials button.
  • You have integrated your GitHub Enterprise account with Pipelines.

    Integrate GitLab

    GitLab is a software repository hosting service that provides revision control and source code management.

    With GitLab integration you can create applications in Pipelines from a GitLab repository and enable auto-builds when a change is checked into the repository.

    Before beginning, ensure you are using the correct user account in Puppet Pipelines.

    To enable GitLab integration, follow these steps.

    1. In the Pipelines web UI click the gear icon at the top right.
    2. Click the Integrations link on the left.
    3. Click the GitLab icon.
    4. Enter the Host http:// or https:// and the dns name for your GitLab host (i.e. gitlab.com for public GitLab).
    5. Retrieve a Personal Access Token from your instance of GitLab.
    6. You can find your access tokens under user settings in GitLab.

      GitLab access tokens
    7. Enter the Token
    8. The SSH User is Optional and defaults to git. Unless your specific GitLab instance has changed the default GitLab SSH username, you can leave this blank
    9. Click Add Credentials button.

    Pipelines will attempt to validate your token. Realize that if your GitLab instance is on a private network behind a firewall, Pipelines may not be able to reach your GitLab. In this scenario we recommend obtaining the on-premises Enterprise version of Pipelines.

    GitHub OAuth Permissions

    When building applications that interact with GitHub users it is helpful to understand the permissions.

    To make API calls that interact with GitHub users you must first create an OAuth application. This OAuth application must specify the permissions necessry for the application. Pipelines is an example Oauth application.

    Pipelines GitHub Permissions

    Pipelines requires the following GitHub permissions:

    Personel user data - Email addresses (read-only)

    This application will be able to read your private email addresses.

    Repositories - Public and private

    This application will be able to read and write all public and private repository data. This includes the following:

    • Code
    • Issues
    • Pull requests
    • Wikis
    • Settings
    • Webhooks and services
    • Deploy keys
    Organizations and teams - Read-only access

    This application will be able to read your organization and team membership.

    Revoking Pipelines Oauth App from GitHub

    1. Login to GitHub.
    2. Click your GitHub profile image at the top right.
    3. Click Settings from the drop down.
    4. In the left menu, click Oauth applications.
    5. Click the Revoke button for Pipelines.

    You have revoked the Pipelines application from your GitHub account.

    Back to top
    The page rank or the 1 our of 5 rating a user has given the page.
    The email address of the user submitting feedback.
    The URL of the page being ranked/rated.