Add a private GitHub repository in Cloud Manager private-repositories
By setting up Cloud Manager to integrate with your private GitHub repositories, you can validate your code directly within GitHub using Cloud Manager. This configuration removes the requirement to sync your code regularly with the Adobe repository.
Configuration configuration
Configuration of a private GitHub repository in Cloud Manager consists of two steps:
- Add a private GitHub repository to a selected program.
- Then, validate ownership of the private GitHub repository.
Add a private GitHub repository to a program add-repo
-
Log into Cloud Manager at my.cloudmanager.adobe.com and select the appropriate organization.
-
On the My Programs console, select the program to which you want to link a private Git repository.
-
In the side menu, under Services, select
-
Near the upper-right corner of the Repositories page, click Add Repository.
-
In the Add Repository dialog box, select Private Repository as the repository type.
-
In each respective field, provide the following details about your repository:
table 0-row-2 1-row-2 2-row-2 3-row-2 Field Description Repository Name An expressive name for your new repository. Repository URL The URL of the private repository, which must end in .git.
For example,https://github.com/org-name/repo-name.git(URL path is for illustration purposes only).Description (optional) A detailed description of the repository. -
Select Save.
Now, you can validate ownership of the private repository.
Validate ownership of a private GitHub 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.
To validate ownership of a private GitHub repository:
-
After adding your own repository, follow the remaining steps in the Private Repository Ownership Validation dialog box.
table 0-row-2 1-row-2 2-row-2 Description Step 1: GitHub App Cloud Manager uses a GitHub app to interact with your private repository securely.
• An owner of your GitHub organization must install the app located athttps://github.com/apps/cloud-manager-for-aemand grant access to the repository.
• For details on installing and granting access is done, see GitHub’s documentation.Step 2: Secret File To enhance security, you must create a secret file in the default branch of your repository.
• Click Generate, then click Confirm. Cloud Manager generates the content of the private file in the Secret file content text field.
• Click
-
Create a new file in the default branch of your GitHub repo called:
.well-known/adobe/cloud-manager-challenge -
Paste the secret file content into the new file you just created, and save.
Once the app is installed and the secret file exists in the repository, continue the step.
-
In the Private Repository Ownership Validation dialog box, click Validate.
The app can be installed and a secret file can be created 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.
The Type column in the table on the Repositories page identifies Adobe-provided repositories (Adobe) and your own private repositories (GitHub).
If you need to return to the repository later to complete the validation, on the Repositories page, click
Use private GitHub repositories with Cloud Manager using
After the GitHub repository is validated in Cloud Manager, the integration is complete. 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 check is complete. The code quality results are then propagated to the GitHub check.
When the pull request is merged or closed, 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 GitHub organization, it 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 always tries to validate the pull requests created for that repository.