DocumentationAEM as a Cloud ServiceUser Guide

GitHub check configuration for private repositories github-check-config

Last update: Fri Oct 18 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Admin
  • Developer

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 configuration file in the default branch of the private repository.

github:
  shouldDeletePreviousComment: false
  shouldSkipCheckAnnotations: 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. Setting it to false (default) means that previous comments are not deleted.
shouldSkipCheckAnnotations
true or false
false
Whether to have additional annotations present on the GitHub pull request check or not. Setting it to false (default) means that check annotations are not skipped and are included in the feedback.
type
CI_CD
n/a
Defines the behavior of CI/CD (Continuous Integration/Continuous Deployment) pipeline configurations.
template.programId
Integer
No pipeline variables are reused
You can use it to reuse the pipeline variables set on an existing pipeline automatically created by each pull request.
template.pipelineId
Integer
No pipeline variables are reused
You can use it to reuse the pipeline variables set on an existing pipeline automatically created by each pull request.
namePrefix
String
Full Stack Code Quality Pipeline for PR
Used to set the prefix for 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
fbcff2a9-b6fe-4574-b04a-21e75df764ab