Integrating Private GitHub Repositories in AEM Cloud Manager

Published
Integrating Private GitHub repositories into AEM Cloud Manager streamlines development workflow by allowing direct code validation within GitHub, eliminating the need for frequent synchronization with Adobe's repository. This article provides a step-by-step guide to integrating private GitHub repositories into AEM Cloud Manager.
The integration process involves two main steps:

Add Private GitHub Repository to Program

Repositories in Cloud Manager are used to store and manage project's code using Git. To add a repository to a program, navigate to the Program Console and click on the Repositories tab. Click the Add Repository button to add a new repository. In the Add Repository dialog box, select Private Repository as the repository type and provide the necessary details about the repository.
Make sure you have Deployment Manager or Business Owner role otherwise you won't be able to add a repository.
GitHub Private Repository

Validate Ownership of the Repository

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.
Validate GitHub Repository Ownership
To validate ownership, you first need to install the Adobe GitHub app and grant access either to all repositories or only to the specific repository you want to integrate with Cloud Manager.
Once you've installed the app, the next step to generate secret file from Cloud Manager and upload it to your GitHub repository. Create a new file of your GitHub repo called: .well-known/adobe/cloud-manager-challenge and paste the secret file content into this file.
Once the app is installed and the secret file exists in the repository, in the Private Repository Ownership Validation dialog box, click Validate. Until validation, the repository is listed with a red icon, indicating that it is not yet validated and cannot yet be used.
After the GitHub repository is validated in Cloud Manager, the integration is complete. You can use the repository with Cloud Manager.

Configuring Code Quality & Deployment Pipeline

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.
GitHub Code Quality Pipeline Result
For Production and Non-Production deployment pipeline, you can configure the pipeline to use the GitHub repository same way as you would with the Adobe repository.
However, when configuring deployment pipelines, you must configure pipeline using a Maven multi-module project. Each deployment generates a new Docker image and deploys it to the AEM as a Cloud Service environment. If you configure it with a single project, it will overwrite and remove any existing projects in the environment.

References

Write your Comment