From 7008f1d5208f5f74b814bc075d05d24b9c088162 Mon Sep 17 00:00:00 2001
From: ClementTsang <34804052+ClementTsang@users.noreply.github.com>
Date: Sun, 26 Feb 2023 00:02:34 -0500
Subject: [PATCH] ci: add some comments regarding codecov to action

---
 .github/workflows/coverage.yml | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
index 471be514..ad2d9a5f 100644
--- a/.github/workflows/coverage.yml
+++ b/.github/workflows/coverage.yml
@@ -1,5 +1,7 @@
 # Code coverage generation via cargo-llvm-cov, which is then uploaded to Codecov.
 # Codecov will report back via a comment if run on a PR.
+#
+# Note that Codecov will report back the average all uploaded coverage files.
 
 name: codecov
 
@@ -17,7 +19,6 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: ${{ github.event_name == 'pull_request' || github.repository != 'ClementTsang/bottom' }}
 
-# TODO: Maybe add this for more than just Linux.
 jobs:
   pre-job:
     runs-on: ubuntu-latest
@@ -70,5 +71,5 @@ jobs:
         with:
           files: lcov.info
           fail_ci_if_error: true
-          token: ${{ secrets.CODECOV_TOKEN }}
+          token: ${{ secrets.CODECOV_TOKEN }} # This is generally not needed, but sometimes the default shared token hits limits.
           flags: ${{ matrix.info.os }}