summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorClementTsang <34804052+ClementTsang@users.noreply.github.com>2023-02-26 00:02:34 -0500
committerClementTsang <34804052+ClementTsang@users.noreply.github.com>2023-02-26 00:03:59 -0500
commit7008f1d5208f5f74b814bc075d05d24b9c088162 (patch)
treed9a6f29d3ebe31c6e7d2368b6d75ae000052a04c
parent870c29e6e09c5430b2b71e53c72ff9329cb92d9b (diff)
ci: add some comments regarding codecov to action
-rw-r--r--.github/workflows/coverage.yml5
1 files 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 }}