feat: Update the structure of new Coverage engine release note DOCS-623…

… (#1970) * feat: First draft * feat: Apply suggestions from review Co-authored-by: Cláudia Carpinteiro <[email protected]> * feat: Apply suggestions from review Co-authored-by: Cláudia Carpinteiro <[email protected]> * feat: Document coverage summaries * fix: Vale warning * fix: Vale warning * feat: Add admonition --------- Co-authored-by: Cláudia Carpinteiro <[email protected]>
codacy · Dec 7, 2023 · a006866 · a006866
1 parent ba93591
commit a006866
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 10 deletions.
diff --git a/.github/styles/Vocab/Codacy/accept.txt b/.github/styles/Vocab/Codacy/accept.txt
@@ -64,6 +64,8 @@ PVC
 Pylint
 remark-lint
 Revive
+Rollout
+rollout
 RuboCop
 sbt
 Scalameta

diff --git a/docs/release-notes/cloud/cloud-2023-11-23-new-coverage-engine-status-checks.md b/docs/release-notes/cloud/cloud-2023-11-23-new-coverage-engine-status-checks.md
@@ -3,19 +3,38 @@ rss_title: Codacy release notes RSS feed
 rss_href: /feed_rss_created.xml
 ---
 
-# New Coverage engine status checks November 23, 2023
+# Rollout of new Coverage engine November 23, 2023
 
-!!! info "This release note applies to the repositories for which you set Codacy to send pull request coverage status data to your Git provider (see how on [GitHub](../../repositories-configure/integrations/github-integration.md#status-checks), [GitLab](../../repositories-configure/integrations/gitlab-integration.md#pull-request-status), and [Bitbucket](../../repositories-configure/integrations/bitbucket-integration.md#pull-request-status))."
+As part of an ongoing effort to improve the speed and value of the insights provided by Codacy, we've been working on a new Coverage engine and started its deployment on November 23rd, 2023. The rollout to use the new engine across Codacy will be phased across several months and will gradually impact the coverage data you see on the Git provider, UI, and API.
 
-On November 23rd 2023 we activated the new, faster Coverage engine and set it to send coverage data to your Git provider. This is part of an ongoing effort to improve the speed and value of the insights provided by Codacy.
+!!! info
+    GitHub only: The new Coverage engine requires updated app permissions. If you haven't done so yet, please [review and accept the updated Codacy app permissions](https://docs.github.com/en/enterprise-cloud@latest/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#reviewing-permissions).
 
-As a consequence of this update, you can now see two additional checks on your pull requests, marked **beta**, alongside the preexisting **Codacy Coverage Report** check. If you are using the Codacy Coverage Report status check to block merging pull requests on GitHub, please [update your setup](#if-you-are-using-the-old-coverage-status-check-to-block-merging-pull-requests-on-github) and avoid disruptions in the future.<!--NOTE Temporary comment for review purpose, to remove-->
+Please refer to the table below for the updated status of the transition process. The table will be updated as changes are introduced.
+
+| Feature                                          | Status      | Notes                                                                                                                                                       |
+|--------------------------------------------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [Git provider status checks](#status-checks)     | Live (beta) | The new Coverage engine now sends coverage data to your Git provider. This data is marked \[beta\] and is shown alongside the data from the current engine. |
+| [GitHub coverage summaries](#coverage-summaries) | Live        | -                                                                                                                                                           |
+| Codacy app UI                                    | Planned     | -                                                                                                                                                           |
+| Codacy API                                       | Planned     | -                                                                                                                                                           |
+
+Because of this transition, both old and new data will coexist during this period, <span class="skip-vale">potentially</span> leading to [differences in reported metrics](#differences-in-coverage-metrics-between-the-old-and-new-coverage-engines).
+
+## Git provider status checks from the new Coverage engine {: id="status-checks"}
+
+!!! info "This section applies to the repositories for which you set Codacy to send pull request coverage status data to your Git provider (see how on [GitHub](../../repositories-configure/integrations/github-integration.md#status-checks), [GitLab](../../repositories-configure/integrations/gitlab-integration.md#pull-request-status), and [Bitbucket](../../repositories-configure/integrations/bitbucket-integration.md#pull-request-status))."
+
+On November 23rd 2023 we set the new Coverage engine to send coverage data to your Git provider. As a consequence of this update, you can now see two additional checks on your pull requests, marked **\[beta\]**, alongside the preexisting **Codacy Coverage Report** check.
+
+!!! important
+    GitHub only: If you are using the Codacy Coverage Report status check to block merging pull requests, please [update your GitHub setup](#if-you-are-using-the-old-coverage-status-check-to-block-merging-pull-requests-on-github) and avoid disruptions in the future.
 
 This is what the new checks look like on each provider:
 
 -   On GitHub:
 
-    ![New Coverage status checks GitHub](../images/ala-695-status-checks-github.png)<!--NOTE Temporary comment for review purpose, to remove-->
+    ![New Coverage status checks GitHub](../images/ala-695-status-checks-github.png)
 
 -   On GitLab:
 
@@ -25,7 +44,7 @@ This is what the new checks look like on each provider:
 
     ![New Coverage status checks Bitbucket](../images/ala-695-status-checks-bitbucket.png)
 
-## Deprecation and removal of the old Coverage engine status checks
+### Deprecation and removal of the old Coverage engine status checks
 
 Currently, Codacy sends coverage data to your Git provider from both the old and new Coverage engines. We will deprecate and later remove the old status checks on the following dates:
 
@@ -40,15 +59,15 @@ Currently, Codacy sends coverage data to your Git provider from both the old and
       <td>February 14th, 2024</td>
       <td>Deprecation of the old Coverage status check</td>
       <td>
-        <p>From this day on, the new checks will be the official status checks for Codacy Coverage and will no longer be marked <strong>beta</strong>. The old check will be marked <strong>deprecated</strong> but will keep working.</p><!--NOTE Temporary comment for review purpose, to remove-->
+        <p>From this day on, the new checks will be the official status checks for Codacy Coverage and will no longer be marked <strong>beta</strong>. The old check will be marked <strong>deprecated</strong> but will keep working.</p>
         <p>If on this date you are still using the old check to block merging pull requests on GitHub, please <a href="#if-you-are-using-the-old-coverage-status-check-to-block-merging-pull-requests-on-github">update your Git provider settings</a>.</p>
       </td>
     </tr>
     <tr>
       <td>April 18th, 2024</td>
       <td>Brownout of the old Coverage status check</td>
       <td>
-        <p>Codacy will not send the old status check on this day.</p><!--NOTE Temporary comment for review purpose, to remove-->
+        <p>Codacy will not send the old status check on this day.</p>
         <p>This will help you confirm that your setup has been updated correctly and lower the risk of disruptions when the old status check is removed.<br/>If on this day you can merge your pull requests using the new checks and don't encounter other issues, it means that your setup has been updated correctly. Otherwise, if on this date you are still using the old check to block merging pull requests on GitHub, please <a href="#if-you-are-using-the-old-coverage-status-check-to-block-merging-pull-requests-on-github">update your Git provider settings</a>.</p>
       </td>
     </tr>
@@ -63,7 +82,7 @@ Currently, Codacy sends coverage data to your Git provider from both the old and
   </tbody>
 </table>
 
-## If you are using the old Coverage status check to block merging pull requests on GitHub
+### If you are using the old Coverage status check to block merging pull requests on GitHub
 
 If you are using the old status check to block merging pull requests on GitHub, remove the old Codacy Coverage Report as a required check of your pull requests' target branch:
 
@@ -72,6 +91,12 @@ If you are using the old status check to block merging pull requests on GitHub,
 
 ![New Coverage status checks GitHub](../images/ala-695-update-status-checks-github.png)
 
+## GitHub coverage summaries from the new Coverage engine {: id="coverage-summaries"}
+
+!!! info "This section applies to the repositories for which you set Codacy to post [coverage summaries](../../repositories-configure/integrations/github-integration.md#coverage-summaries) to your GitHub pull requests"
+
+On December 7th 2023 we set the new Coverage engine to post coverage summaries to GitHub, replacing the old Coverage engine. No further action is required on your part.
+
 ## Differences in coverage metrics between the old and new Coverage engines
 
 You may notice some differences in the coverage metrics reported by the old and new Coverage engines and may need to update your [coverage gate rules](../../repositories-configure/adjusting-quality-gates.md) accordingly. This may happen because the new Coverage engine calculates coverage metrics considering all the files included in the coverage report, while the old Coverage engine ignores some files:

diff --git a/docs/release-notes/index.md b/docs/release-notes/index.md
@@ -19,7 +19,7 @@ For product updates that are in progress or planned [visit the Codacy public roa
 2023
 
 -   [Cloud November 2023](cloud/cloud-2023-11.md)
--   [New Coverage engine status checks November 23, 2023](cloud/cloud-2023-11-23-new-coverage-engine-status-checks.md)
+-   [Rollout of new Coverage engine November 23, 2023](cloud/cloud-2023-11-23-new-coverage-engine-status-checks.md)
 -   [Removal of Jira, Slack, and Webhooks repository integrations November 13, 2023](cloud/cloud-2023-11-13-jira-slack-webhooks-repo-integrations-removal.md)
 -   [Cloud October 2023](cloud/cloud-2023-10.md)
 -   [Deprecation of CSSLint, JSHint, Faux Pas, Tailor, TSLint October 25, 2023](cloud/cloud-2023-10-25-csslint-jshint-fauxpas-tailor-tslint-deprecation.md)
-Original file line number
+Diff line change
@@ Expand Up / @@ -64,6 +64,8 @@ PVC @@
     Pylint
     remark-lint
     Revive
+    Rollout
+    rollout
     RuboCop
     sbt
     Scalameta
@@ Expand Down @@