Add private repositories in Cloud Manager private-repositories
Learn how to set up Cloud Manager to work with your own private GitHub repositories.
Overview overview
Configuring Cloud Manager with your private GitHub repositories lets you validate code directly within GitHub, eliminating the need to sync with the Adobe repository frequently.
Configuration configuration
Configuration consists of two main steps:
Add a repository add-repo
-
In Cloud Manager, from the Program Overview page, click the Repositories tab to switch to the Repositories page and click Add Repository.
-
In the Add Repository dialog box, select Private Repository as the repository type.
-
Provide the details of your repository
- Repository Name - An expressive name
- Repository URL - The URL of the repository, which must end in
.git - Description (optional) - A longer description of the repository as necessary
-
Click Save.
Validate ownership of a private repository validate-ownership
Cloud Manager now knows about your GitHub repository, but it still needs access to it. To grant access, you need to install the Adobe GitHub app and verify that you own the specified repository.
-
After adding your own repository, the Private Repository Ownership Validation dialog box is displayed.
-
Cloud Manager uses a GitHub app to interact with your repository securely.
An owner of your GitHub organization must install the app located at
https://github.com/apps/cloud-manager-for-aemand grant access to the repository. See GitHub’s documentation for details. -
To enhance security, create a secret file in the default branch of your repository. Click Generate.
-
Confirm the generation of the secret file by clicking Confirm.
-
Back in the Private Repository Ownership Validation dialog box, Cloud Manager has generated the content in the Secret file content field. Copy the content from that field.
The contents of the secret file is only shown once. If you do not copy the content before closing this window, you must regenerate the secret.
-
Create a new file in the default branch of your GitHub repo called
.well-known/adobe/cloud-manager-challengeand paste the secret file content into that file and save. -
After the app is installed and the secret file exists in the repository, you can click Validate in the Private Repository Ownership Validation dialog.
The app can be installed and you can generate a secret file in any order. However, both steps must be completed before you can validate.
Until validation, the repository is listed with a red icon, indicating that it is not yet validated and cannot yet be used.
Note that the Type column easily identifies Adobe-provided repositories (Adobe) and your own GitHub repositories (GitHub).
To return to the repository later and complete the validation, go to the Repositories page. Click the ellipsis button next to the GitHub repository that you added and select Ownership Validation from the drop-down menu.
Use private repositories with Cloud Manager using
After the GitHub repository is validated in Cloud Manager, the integration is completed and you can use the repository with Cloud Manager.
To use private repositories with Cloud Manager:
-
When you create a pull request, a GitHub check starts automatically.
-
For each pull request, a full stack code quality pipeline is created automatically. This pipeline is started at each pull request update.
-
The GitHub check remains in a running state until the code quality checks are complete. The code quality results are then propagated to the GitHub check.
When the pull request is closed or merged, the full stack code quality pipeline created is automatically deleted.
Associate private repositories with pipelines pipelines
Validated private repositories can be associated with full-stack and frontend pipelines.
Limitations limitations
Certain limitations apply when using private repositories with Cloud Manager.
- Web tier and config pipelines are not supported with private repositories.
- No Git tag is created and pushed when using private repositories on production full stack pipelines.
- If the Adobe GitHub app is removed from your GitHb organization, this action removes the pull requests validation feature for all repositories.
- Pipelines using private repositories and the on-commit build trigger are not started automatically when a new commit is pushed into the selected branch.
- Artifact reuse functionality does not apply to private repositories.
- You cannot pause the pull request validation using the GitHub check from Cloud Manager. If the GitHub repository is validated in Cloud Manager, Cloud Manager tries to validate the pull requests created for that repository.