Pull request checks for private repositories github-check-config
Learn how to control the pipelines that are created automatically to validate each pull request to a private repository.
Configuration of private repository 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.
pullRequest:
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
shouldDeletePreviousCommenttrue or falsefalseWhether 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.shouldSkipCheckAnnotationstrue or falsefalseWhether 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.typeCI_CDn/a
Defines the behavior of CI/CD (Continuous Integration/Continuous Deployment) pipeline configurations.
template.programIdInteger
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.pipelineIdInteger
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.
namePrefixString
Full Stack Code Quality Pipeline for PRUsed to set the prefix for the name of the pipeline that is created automatically.
importantMetricsFailureBehaviorCONTINUE or FAIL or PAUSECONTINUESets the important metric behavior of the pipeline
CONTINUE = If an important metric fails, the pipeline moves forward automaticallyFAIL = The pipeline finishes with a FAILED status if an important metric failsPAUSE = The code scanning step receives a WAITING status when an important metric fails and must be manually resumedrecommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab