GitHub check annotations github-annotations

Learn how GitHub checks annotate PRs for your private repositories to provide you with helpful feedback.

Overview overview

If you use private repositories for your Cloud Manager program, checks in GitHub are automatically run for every pull request. These checks are annotated with useful information to help you understand any issues with your code as soon as possible.

Example of GitHub check annotations

Code quality issues detected by SonarQube are clearly listed.

Example of code issue annotation

The exact line of code with the issue is provided and you can click it to show the relevant code. These annotations are provided for all code issues, not just those issues changed in the pull request.

Example of code issue annotation

All annotated lines are aggregated on the Files Changed tab on the GitHub pull request. Annotations for files that were not changed in the pull request appear in their own section.

Example of annotations on files changed tab

Code Quality pipelines code-quality-pipelines

The Code Quality results are also visible in the pipeline, which Cloud Manager triggers automatically at the bottom of the Checks tab. It is also accessible from the Details of the check of the pull request.

Example of annotations

Example of annotations

You can also visualize the issues in the form of a CSV. This method can be retrieved by viewing the details of the pipeline execution in Cloud Manager.

recommendation-more-help
c6cdc82b-cee9-48e0-a6ee-48149d5e72c3