From fed22c35544119dbbce6bad4166f2d023d148652 Mon Sep 17 00:00:00 2001 From: Peeter Piegaze Date: Thu, 12 May 2022 14:06:26 +0200 Subject: SONAR-16316 Update the sonarqube docs to inform users of how to download a regulatory report --- .../portfolio-pdf-configuration.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/server/sonar-docs/src/pages/project-administration/portfolio-pdf-configuration.md b/server/sonar-docs/src/pages/project-administration/portfolio-pdf-configuration.md index 5999187ec80..10debc89626 100644 --- a/server/sonar-docs/src/pages/project-administration/portfolio-pdf-configuration.md +++ b/server/sonar-docs/src/pages/project-administration/portfolio-pdf-configuration.md @@ -46,4 +46,19 @@ You have the following options for subscription frequency: - **Monthly (default)** – report is sent during the first portfolio calculation of the month (if any), starting from the first day of the current month ### Sending portfolio PDF reports to non-SonarQube users -Users with administrative rights on a portfolio can send the portfolio PDF report to non-SonarQube users by adding their email in the **Other Recipients** field at **Portfolio Settings > Executive Report**. \ No newline at end of file +Users with administrative rights on a portfolio can send the portfolio PDF report to non-SonarQube users by adding their email in the **Other Recipients** field at **Portfolio Settings > Executive Report**. + +## Regulatory PDF Reports + +Users with access to a project can download a regulatory report for any permanent branch of that project. +A permanent branch is one that has been set to **Keep when inactive** (see [Branch Analysis](/branches/overview/) for details on how to adjust this setting). + +To download the regulatory report, go to **Project Information > Regulatory Report** and select the desired branch. +The report will be dynamically generated and downloaded. +This may take a few minutes. + +The report is a zip file containing a snapshot of the selected branch. It contains: + +* An overview of the the selected branch of the project. +* The configuration items relevant to the project's quality (quality profile, quality gate, and analysis exclusions). +* Lists of findings for both new and overall code on the selected branch. -- cgit v1.2.3