Introduction
Understanding organizationsUnderstanding componentsManage organizationsManage componentsManage component Jira integrations
Set up your first organizationUnderstanding users and teamsUnderstanding role-based access controlManage usersManage teamsConfigure role-based access controlRBAC permissions reference
Understanding authentication in CloudBees UnifySet up multifactor authenticationConfigure SAML single sign-onConfigure OIDC authenticationConfigure network security policiesNetwork security reference
Understanding platform configurationUnderstanding environmentsManage properties and secretsManage environmentsTrack environment inventoryConfigure containersSet up preconfigured actionsConfigure notifications
Accessibility policy referenceShared responsibility model referenceSubscription and services agreementSupport policiesSupported browsers and external tools
Introduction
Understanding feature managementUnderstanding Configuration as CodeGet started with feature managementCreate and manage feature flagsConfigure feature flag targetingOrganize feature flagsImplement feature flag governanceConfiguration as Code reference
Understanding flag impressions and activity statusUnderstanding flag healthUnderstanding code referencesReview and clean up feature flagsSet up code references
Understanding Jira integration for feature flagsSet up the Jira integrationLink Jira tickets to feature flags
Understanding multiple SDK keysBuild your first mobile app with feature flagsBuild your first feature-flagged web applicationBuild your first feature-flagged backend serviceInstall client-side SDKsInstall server-side SDKsConfigure multiple SDK keysMobile SDK referenceWeb SDK referenceBackend SDK referenceClient SDK referenceFlag implementation reference
Introduction
Understanding CI workflowsCreate a build workflowCreate and manage workflowsCreate reusable workflowsTest and validate containers in workflowsCheck out source codeTrigger workflows remotelyWorkflow syntax referenceJobs syntax referenceSteps syntax referenceServices syntax reference
Monitor workflow runsView test results in runsView evidence in runsView deployments in runsManage workflow artifactsPublish test resultsPublish evidence itemsGenerate a software bill of materialsManage ServiceNow change requests
Configure workflow credentialsConfigure AWS credentialsConfigure container registry credentialsConfigure Git credentialsIntegrate external secret providers
Understanding GitHub Actions integrationSet up GitHub Actions integrationDisplay GitHub Actions workflows and runsRegister GHA build artifactsPublish GHA deployed artifactsPublish GHA test resultsPublish GHA evidence itemsTrigger CloudBees workflows from GitHub ActionsScan with GitHub Actions
Understanding CloudBees CI and Jenkins® integrationConnect CI and Jenkins controllersMonitor CI and Jenkins buildsRegister CI build artifactsRegister CI deployed artifactsPublish CI test resultsConfigure CI security scanningCI and Jenkins integration reference
Build and publish container imagesUnderstanding external CI/CD integrationsRun external CI/CD jobsExternal CI/CD action reference
Introduction
Understanding release orchestrationManage applicationsCreate deployer workflowsCreate staged workflowsCreate and manage releasesOrchestrate multi-workflow releasesRelease management reference
Understanding artifact managementRegister and track artifactsStore and retrieve artifactsPromote artifactsGenerate a software bill of materialsArtifact management reference
Deploy with HelmDeploy to KubernetesContainer deployment reference
Deploy to AWSAWS deployment reference
Deploy with enterprise platformsExecute remote deployment commandsEnterprise deployment reference
Verify deployments with New RelicDeployment verification reference

Connect your repository

3 minute read

In this tutorial we will connect a GitHub repository to CloudBees Unify using a sample Go application template, creating the foundation for automated workflows. Along the way we will encounter the GitHub App integration model, repository templates, and how CloudBees Unify connects to source code.

By the end, you will have a working repository connection ready for creating components and workflows.

Before we begin, ensure you have:

  • A valid GitHub account

  • Access to at least one organization in CloudBees Unify

Create your sample repository

Now we’ll create a new GitHub repository from the CloudBees sample Go app template. This template provides a complete working application that we can use throughout the tutorial series.

  1. Go to the CloudBees sample Go app repository, and select Use this template.

  2. To copy the template repository, select the Create a new repository option.

    Copy the CloudBees template repository
    Figure 1. Create a new repository from a sample Go app

  3. Do not select Include all branches.

  4. Select your GitHub ID from the options.

  5. Enter a Repository name.

  6. (Optional) Enter a Description.

  7. Select either Public or Private, according to your requirements.

  8. Select Create repository.

Your new repository is created in your GitHub account from the CloudBees sample Go app template. You can see the complete Go application code structure, including source files, tests, and configuration. We are now ready to connect this repository to CloudBees Unify.

Set up the GitHub App integration

Now we’ll connect CloudBees Unify to your new repository by creating a GitHub App integration. This integration allows CloudBees Unify to access your repository and use it in components and workflows.

  1. Select an organization, and then select Configurations  Integrations.

  2. Select Create integration. The list of available integrations displays.

    Create an integration
    Figure 2. Create a new integration

  3. Select GitHub App from the list of available integration types.

  4. Enter a Name for the GitHub App.

  5. (Optional) Enter a Description.

  6. Select Install GitHub App.

This action redirects you to GitHub for the authorization process. GitHub will ask you to confirm which repositories CloudBees Unify can access.

  1. Select the GitHub account or GitHub organization where you created the sample Go app repository.

    Create environment
    Figure 3. GitHub App installation with available GitHub organization highlighted

  2. Select All repositories or Only select repositories, and select the name of your sample Go app repository from the options.

  3. Select Install & Authorize.

The authorization process completes and redirects you back to CloudBees Unify. Your integration is now connected and ready to use.

Verify your repository connection

Let’s confirm that the repository connection is working properly and available for creating components.

The integration is connected and can now be used when creating components and workflows that reference this repository.

Notice that GitHub App integrations created for source code access may not appear as standalone entries in Configurations  Integrations. These integrations are used implicitly by CloudBees Unify and applied automatically when you create components and workflows that reference the repository.

If you previously created and authorized a GitHub App, CloudBees Unify reuses the existing app and may skip the Install and Authorize step.

What we accomplished

We have successfully connected a GitHub repository to CloudBees Unify through a secure GitHub App integration. Along the way we encountered repository templates, the GitHub App authorization model, and how CloudBees Unify manages source code connections.

You now have a working repository connection that serves as the foundation for all CloudBees Unify automation features.

From here, you can: