DocumentationAEMCloud Manager Documentation for AEM 6.x

GitHub check configuration for private repositories github-check-config

Last update: Thu Aug 22 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Admin

Learn how to 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 is 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 this GitHub pull request or keep all.
type
CI_CD
n/a
Defines the behavior of a CI/CD pipeline.
template.programID
Integer
No pipeline variables are reused
You can reuse the pipeline variables set on an existing pipeline, which each PR creates automatically.
template.pipelineID
Integer
No pipeline variables are reused
You can reuse the pipeline variables set on an existing pipeline, which each PR creates automatically.
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 moves forward automatically
FAIL = The pipeline finishes with a FAILED status if an important metric fails
PAUSE = The code scanning step receives a WAITING status when an important metric fails and must be manually resumed.
recommendation-more-help
c6cdc82b-cee9-48e0-a6ee-48149d5e72c3