DocumentationAEM as a Cloud ServiceUser Guide

GitHub Check Configuration for Private Repositories github-check-config

Last update: Wed Jun 19 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Admin
  • Developer

Learn how control the pipelines that are created automatically to validate each pull request to a private repository.

Configuration of GitHub Checks configuration

When using private repositories, a full stack code quality pipeline will be created automatically. This pipeline is started at each pull request update.

You can control these checks by creating a .cloudmanager/pr_pipelines.yml file in the default branch of the private repository.

github:
  shouldDeletePreviousComment: false
pipelines:
  - type: CI_CD
    template:
      programId: 1234
      pipelineId: 456
    namePrefix: Full Stack Code Quality Pipeline for PR
    importantMetricsFailureBehavior: CONTINUE
Parameter
Possible Values
Default
Description
shouldDeletePreviousComment
true or false
false
Whether to keep only the last comment with the code scanning results on his github pull request or keep all
type
CI_CD
n/a
Defines behavior of a CI/CD pipeline
template.programID
Integer
No pipeline variables are reused
Can be used to reuse the pipeline variables that are set on one of the existing pipelines that are created automatically by each PR.
template.pipelineID
Integer
No pipeline variables are reused
Can be used to reuse the pipeline variables that are set on one of the existing pipelines that are created automatically by each PR.
namePrefix
String
Full Stack Code Quality Pipeline for PR
Used to set the name of the pipeline that is created automatically
importantMetricsFailureBehavior
CONTINUE or FAIL or PAUSE
CONTINUE
Sets the important metric behavior of the pipeline
CONTINUE = If an important metric fails, the pipeline will move forward automatically
FAIL = The pipeline will finish with a FAILED status if an important metric fails
PAUSE = The code scanning step will receive a WAITING status when an important metric fails and must be manually resumed
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab