GitHub Enterprise Server integration Preview
| The GitHub Enterprise Server integration is currently in Preview. Access is provided on request and involves hands-on support from the CircleCI team. Some features are not yet available during Preview. To learn more or request access, contact your account team. |
Overview
CircleCI Cloud supports GitHub Enterprise Server as an add-on VCS integration. If your organization uses a self-hosted GitHub instance, you can connect it to CircleCI Cloud.
Using the add-on VCS integration, you get the same CI/CD experience available to GitHub Cloud users, without needing to run and maintain your own instance of CircleCI Server.
The GitHub Enterprise Server integration provides the same functionality as CircleCI’s existing GitHub App Integration that is available for GitHub Cloud (GitHub.com and GitHub Enterprise Cloud). This includes pipeline triggering, project setup, commit status reporting, and all supported trigger event types.
Supported functionality
The following functionality is available during Preview:
-
Pipeline triggering from GitHub events including push, pull request, and all other Supported Trigger Event Options.
-
Custom webhook triggers.
-
API triggers.
-
Scheduled pipelines.
-
Commit status reporting to your GitHub Enterprise Server.
-
Pipeline definitions and triggers viewable and manageable in the Project Setup page.
-
HTTPS code checkout (same as GitHub App for GitHub Cloud).
-
Custom configuration file paths and cross-repo pipeline/trigger setups.
Not yet available in Preview
The following features are not yet available for the GitHub Enterprise Server integration. These are planned for future releases:
-
Self-serve onboarding
-
GitHub Checks
-
Chunk
-
Rollback functionality
Currently, onboarding to use the GitHub Enterprise Server integration is assisted by the CircleCI team.
Organization type
The GitHub Enterprise Server integration is available to both circleci and github type organizations. We recommend using a circleci type organization.
For details on how organization types work, see the Users, Organizations, and Integrations Guide.
Connectivity
Your GitHub Enterprise Server instance must be accessible over HTTPS for CircleCI Cloud to connect to it.
If your instance is behind a firewall or not accessible over the public internet, contact your account team to discuss private connectivity options.
Pipeline values
GitHub App Server pipelines use github_server as the value for pipeline.integration_source. All other pipeline values available to GitHub App pipelines are also available to GitHub App Server pipelines. For a full reference, see Project Values and Variables.