蜜豆视频

DocumentationAEM as a Cloud ServiceUser Guide

Add external repositories in Cloud Manager - Limited beta external-repositories

Last update: Thu Apr 03 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Admin
  • Developer

Learn how to add an external repository into Cloud Manager. Cloud Manager supports integration with GitHub Enterprise, GitLab, and Bitbucket repositories.

NOTE
This feature is only available through the early adoption program. For more details and to sign up as an early adopter, see Bring Your Own Git - now with support for GitLab and Bitbucket.

Configure an external repository

Configuration of an external repository in Cloud Manager consists of three steps:

  1. Add an external repository to a selected program.
  2. Provide an access token to the external repository.
  3. Validate ownership of the private GitHub repository.
  4. Configure a webhook to an external repository.

Add an external repository add-ext-repo

  1. Log into Cloud Manager at and select the appropriate organization.

  2. On the My Programs console, select the program to which you want to link an external repository.

  3. In the side menu, under Program, click Folder outline icon Repositories.

    The Repositories page

  4. Near the upper-right corner of the Repositories page, click Add Repository.

  5. In the Add Repository dialog box, select Private Repository to link an external Git repository to your program.

    Add own repository

  6. In each respective field, provide the following details about your repository:

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
    Field Description
    Repository Name Required. An expressive name for your new repository.
    Repository URL Required. The URL of the repository.

    If you are using a GitHub-hosted repository, the path must end in .git.
    For example, https://github.com/org-name/repo-name.git (URL path is for illustration purposes only).

    If you are using an external repository, it must use the following URL path format:
    https://git-vendor-name.com/org-name/repo-name.git
    or
    https://self-hosted-domain/org-name/repo-name.git
    And match your Git vendor.
    Select Repository Type

    Required. Select the repository type that you are using:

    • GitHub (GitHub Enterprise and the self-hosted version of GitHub)
    • GitLab (both gitlab.com and the self-hosted version of GitLab)
    • Bitbucket (both bitbucket.org and Bitbucket server, and the self-hosted version of Bitbucket)

    If the repository URL path above includes the Git vendor name, such as GitLab or Bitbucket, the repository type is already pre-selected for you.
    Description Optional. A detailed description of the repository.

  7. Select Save to add the repository.

  8. In the Private Repository Ownership Validation dialog box, provide an access token to validate ownership of the external repository so you can access it.

    Selecting an existing access token for a repository
    Selecting an existing access token for a Bitbucket repository.

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
    Token type Description
    Use existing Access Token If you have already provided a repository access token for your organization and have access to multiple repositories, you can select an existing token. Use the Token Name drop-down list to choose the token you want to apply to the repository. Otherwise, add a new access token.
    Add new Access Token

    Repository type: GitHub Enterprise

    • In the Token Name text field, type a name for the access token you are creating.

    • Create a personal access token by following the instructions in the .

    • Required permissions for the GitHub Enterprise Personal Access Token (PAT)
      These permissions ensure that Cloud Manager can validate pull requests, manage commit status checks, and access necessary repo details.
      When you generate the PAT in GitHub Enterprise, make sure it includes the following repository permissions:

      • Pull request (read and write)
      • Commit statuses (read and write)
      • Repository metadata (read-only)
    • In the Access Token field, paste the token you just created.

    Repository type: GitLab

    • In the Token Name text field, type a name for the access token you are creating.

    • Create a personal access token by following the instruction in the .

    • Required permissions for the GitLab Personal Access Token (PAT)
      These scopes allow Cloud Manager to access repository data and user information as needed for validation and webhook integration.
      When you generate the PAT in GitLab, make sure it includes the following token scopes:

      • api
      • read_user
    • In the Access Token field, paste the token you just created.

    Repository type: Bitbucket

    • In the Token Name text field, type a name for the access token you are creating.

    • Create a repository access token using the .

    • Required permissions for the Bitbucket Personal Access Token (PAT)
      These permissions allow Cloud Manager to access repository content, manage pull requests, and configure or react to webhook events.
      When you create the app password in Bitbucket, make sure it includes the following required app password permissions:

      • Repository (read-only)
      • Pull requests (read and write)
      • Webhooks (read and write)
    • In the Access Token field, paste the token you just created.
    note note
    NOTE
    The feature Add new Access Token is currently in the Early Adopters phase. Additional functionalities are being planned. As a result, the required permissions for access tokens may change. Additionally, the user interface for managing tokens may be updated, potentially including features like token expiration dates. And, automated checks to ensure that tokens linked to repositories remain valid.

  9. Click Validate.

After validation, the external repository is ready to use and link to a pipeline.

  1. Add or edit a pipeline:

    Pipeline's source code repository and Git branch
    Add Non-Production Pipeline dialog box with selected repository and Git branch,

  2. When adding or editing a pipeline, to specify the Source Code location for your new or existing pipeline, choose the external repository you want to use from the Repository drop-down list.

  3. In the Git Branch drop-down list, select the branch as the source for the pipeline.

  4. Click Save.

TIP
For details about managing repositories in Cloud Manager, see Cloud Manager Repositories.

Configure a webhook for an external repository configure-webhook

Cloud Manager lets you configure webhooks for external Git repositories that you have added. See Add an external repository. These webhooks permit Cloud Manager to receive events that are related to different actions within your Git vendor solution.

For example, webhooks allow Cloud Manager to trigger actions based on events such as the following:

  • Pull request (PR) creation 鈥 Initiates PR validation functionality.
  • Push events 鈥 Starts pipelines when the 鈥淥n Git Commit鈥 trigger is turned on (enabled).
  • Future comment-based actions 鈥 Allows workflows, such as direct deployment from a PR, to a Rapid Development Environment (RDE).

Webhook configuration is not required for repositories hosted on GitHub.com because Cloud Manager integrates directly through the GitHub app.

For all other external repositories that are onboarded with an access token, such as GitHub Enterprise, GitLab, and Bitbucket, webhook configuration is available and must be set up manually.

To configure a webhook for an external repository:

  1. Log into Cloud Manager at and select the appropriate organization.

  2. On the My Programs console, select the program to which you want to configure a webhook for an external Git repository.

  3. In the upper-left corner of the page, click Show menu icon to reveal the left side menu.

  4. In the left side menu, Under the Program heading, click Folder outline icon Repositories.

  5. On the Repositories page, using the Type column to guide you in your selection, locate the repository you want, then click Ellipsis - More icon next to it.

    Config Webhook option on drop-down menu for a selected repository

  6. From the drop-down menu, click Config Webhook.

    Configure Webhook dialog box

  7. In the Config Webhook dialog box, do the following:

    1. Next to the Webhook URL field, click Copy icon .
      Paste the URL in a plain text file. The copied URL is required for your Git vendor鈥檚 Webhook settings.
    2. Next to the Webhook Secret token/key field, click Generate, then click Copy icon .
      Paste the secret in a plain text file. The copied secret is required for your Git vendor鈥檚 Webhook settings.

  8. Click Close.

  9. Navigate to your Git vendor solution (GitHub Enterpriser, GitLab, or Bitbucket).

    All the details on the webhook configuration and the events that are required for each vendor are available in Add an external repository. Under step 8, see the table.

  10. Locate the solution鈥檚 Webhook Settings section.

  11. Paste the Webhook URL that you copied earlier into the URL text field.

    1. Replace the api_key query parameter in the Webhook URL with your own real API key.

      To generate an API key, you must create an integration project in 蜜豆视频 Developer Console. See for full details.

  12. Paste the Webhook Secret that you copied earlier into the Secret (or Secret key, or Secret token) text field.

  13. Configure the webhook to send the required events that Cloud Manager expects.

    table 0-row-2 1-row-2 2-row-2 3-row-2
    Repository Required webhook events
    GitHub Enterprise

    These events allow Cloud Manager to respond to GitHub activity, such as pull request validation, push-based triggers for pipelines, or Edge Delivery Services code sync.
    Make sure that the webhook is set up to trigger on the following required webhook events:

    • Pull requests
    • Pushes
    • Issue comments
    GitLab

    These webhook events allow Cloud Manager to trigger pipelines when code is pushed or a merge request is submitted. They also track comments related to pull request validation (through note events).
    Make sure that the webhook is set up to trigger on the following required webhook events

    • Push events
    • Merge request events
    • Note events
    Bitbucket

    These events ensure that Cloud Manager can validate pull requests, respond to code pushes, and interact with comments for pipeline coordination.
    Make sure that the webhook is set up to trigger on the following required webhook events

    • Pull request: Created
    • Pull request: Updated
    • Pull requests: Merged
    • Pull request: Comment
    • Repository: Push

Validation of pull requests with webhooks

After webhooks are correctly configured, Cloud Manager automatically triggers pipeline executions or PR validation checks for your repository.

The following behaviors apply:

  • GitHub Enterprise

    When the check is created, it appears like the following screenshot below. The key difference from GitHub.com is that GitHub.com uses a check-run, while GitHub Enterprise (using personal access tokens) generates a commit status:

    Commit status to indicate PR validation process on GitHub Enterprise

  • Bitbucket

    When code quality validation is running:

    Status while code quality validation is running

    Uses commit status for tracking PR validation progress. In the following case, the screenshot shows what happens when a code quality validation fails due to a customer issue. A comment is added with detailed error information, and a commit check is created, which shows the failure (visible on the right):

    Pull request validation status for Bitbucket

  • GitLab

    GitLab interactions rely solely on comments. When validation begins, a comment is added. When validation is complete (whether successful or failed), the initial comment is removed and replaced with a new comment containing validation results or error details.

    When code quality validation is running:

    When code quality validation is running

    When cold quality validation is finished:

    When cold quality validation is finished

    When code quality validation fails with an error:

    When code quality validation fails with an error

    When the code quality validation fails due to customer issues:

    When the code quality validation fails due to customer issues

Troubleshoot webhook issues

  • Ensure that the Webhook URL includes a valid API key.
  • Check that webhook events are correctly configured in your Git vendor settings.
  • If PR validation or pipeline triggers are not working, verify that the Webhook Secret is up to date in both Cloud Manager and your Git vendor.

Limitation

  • External repositories cannot be linked to Configuration pipelines.
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab