From dab7bfae1b0daa5d2be1fe1ee9960eb06b54c9fc Mon Sep 17 00:00:00 2001
From: Gguidini <giovanni@codecov.io>
Date: Mon, 9 Oct 2023 12:57:42 +0200
Subject: [PATCH] Add comments to changes outside the workflow file

---
 .github/workflows/codecov_ats.yml | 14 +++++++++-----
 Makefile                          |  3 +++
 2 files changed, 12 insertions(+), 5 deletions(-)

diff --git a/.github/workflows/codecov_ats.yml b/.github/workflows/codecov_ats.yml
index 10cc52b235628d..fb7e2da966ffdb 100644
--- a/.github/workflows/codecov_ats.yml
+++ b/.github/workflows/codecov_ats.yml
@@ -40,11 +40,15 @@ jobs:
         runs-on: ubuntu-latest
         # Map a step output to a job output
         outputs:
-          ATS_TESTS_TO_RUN: ${{ steps.label_analysis.outputs.ATS_TESTS_TO_RUN }}
-          ATS_TESTS_TO_SKIP: ${{ steps.label_analysis.outputs.ATS_TESTS_TO_SKIP }}
+          ATS_TESTS_TO_RUN: ${{ steps.codecov_automated_test_selection.outputs.ATS_TESTS_TO_RUN }}
+          ATS_TESTS_TO_SKIP: ${{ steps.codecov_automated_test_selection.outputs.ATS_TESTS_TO_SKIP }}
         steps:
         - uses: actions/checkout@v3
           with:
+            # fetch-depth: 0 - Use if the BASE_COMMIT on codecov_automated_test_selection is at unknown depth
+            #                   (i.e. git merge-base ${{ github.sha }}^ origin/main)
+            # fetch-depth: 2 - Use if the BASE_COMMIT on codecov_automated_test_selection is at known depth
+            #                   (i.e. git rev-parse ${{ github.sha }}^)
             fetch-depth: 2
         - name: Set up Python 3.10.10
           uses: actions/setup-python@v4
@@ -83,10 +87,10 @@ jobs:
           env:
             CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
             CODECOV_STATIC_TOKEN: ${{ secrets.CODECOV_STATIC_TOKEN }}
-        # Run label analysis in dry mode to get the list of tests to run
+        # Run Automated Test Selection in dry mode to get the list of tests to run
         # The base commit will be the parent commit (apparently commits on master don't exist in codecov)
-        - name: Label Analysis
-          id: label_analysis
+        - name: Codecov Automated Test Selection
+          id: codecov_automated_test_selection
           continue-on-error: true
           run: |
             BASE_COMMIT=$(git rev-parse ${{ github.sha }}^)
diff --git a/Makefile b/Makefile
index f059d4f664031d..f4855b193875d3 100644
--- a/Makefile
+++ b/Makefile
@@ -125,6 +125,9 @@ test-js-ci: node-version-check
 	@yarn run test-ci
 	@echo ""
 
+# --cov-context=test is used to annotate what tests are being executed in the coverage info
+# And it's used to power Codecov Automated Test Selection
+# (see .github/workflows/codecov_ats.yml)
 test-python-ci: create-db
 	@echo "--> Running CI Python tests"
 	pytest \