feat: 🎸 Add Codecov token on package and template

Add CODECOV_TOKEN to the tests. This is done via the reusable workflow
secrets key. This is done both for the package and for the template.

Add information to the full guide on how to add a CODECOV_TOKEN to your
repo.

✅ Closes: #101, #150

.github/workflows/ReusableTest.yml

@@ -19,6 +19,13 @@ on:
         required: false
         type: boolean
         default: false
+      run_codecov:
+        required: false
+        type: boolean
+        default: false
+    secrets:
+      codecov_token:
+        required: true
 
 jobs:
   test:
@@ -44,6 +51,9 @@ jobs:
         env:
           TMPDIR: "${{ runner.temp }}"
       - uses: julia-actions/julia-processcoverage@v1
+        if: ${{ inputs.run_codecov }}
       - uses: codecov/codecov-action@v4
+        if: ${{ inputs.run_codecov }}
         with:
           file: lcov.info
+          token: ${{ secrets.codecov_token }}

.github/workflows/Test.yml

@@ -15,6 +15,9 @@ jobs:
       version: ${{ matrix.version }}
       arch: ${{ matrix.arch }}
       allow_failure: ${{ matrix.allow_failure }}
+      run_codecov: ${{ matrix.version == "1" && matrix.os == "ubuntu-latest" }}
+    secrets:
+      codecov_token: ${{ secrets.CODECOV_TOKEN }}
     strategy:
       fail-fast: false
       matrix:

.github/workflows/TestOnPRs.yml

@@ -24,3 +24,6 @@ jobs:
       version: "1"
       arch: x64
       allow_failure: false
+      run_codecov: true
+    secrets:
+      codecov_token: ${{ secrets.CODECOV_TOKEN }}

docs/src/10-full-guide.md

@@ -78,6 +78,22 @@ julia> DocumenterTools.genkeys(user="UserName", repo="PackageName.jl")
 
 Follow the instruction in the terminal.
 
+### Enable Codecov for code coverage
+
+If you don't have a Codecov account, go to <https://codecov.io> and create one now.
+After creating an account and logging in, you will see your main page with a list of your packages.
+Select the one that you are creating, it will open a configuration page.
+
+On the configuration page, select "Using GitHub Actions" as your CI.
+The first step in the list given you the `CODECOV_TOKEN`. Click on the "repository secret" link on that page.
+It should lead you to the GitHub settings > secrets and variables > actions, under a "New secret" screen.
+Write `CODECOV_TOKEN` on the "Name" field and paste the token that you see on codecov on the "Secret" field.
+Click "Add secret".
+
+Step 2 is not necessary because it is already present in the template.
+
+The next time that the tests are run, the coverage page will be updated, and the badge will be fixed.
+
 ### Add key for Copier.yml workflow (or delete it)
 
 You can reapply the template in the future. This is normally a manual job, specially because normally there are conflicts.

template/.github/workflows/ReusableTest.yml

@@ -19,6 +19,13 @@ on:
         required: false
         type: boolean
         default: false
+      run_codecov:
+        required: false
+        type: boolean
+        default: false
+    secrets:
+      codecov_token:
+        required: true
 
 jobs:
   test:
@@ -37,6 +44,9 @@ jobs:
       - uses: julia-actions/julia-buildpkg@v1
       - uses: julia-actions/julia-runtest@v1
       - uses: julia-actions/julia-processcoverage@v1
+        if: ${{ inputs.run_codecov }}
       - uses: codecov/codecov-action@v4
+        if: ${{ inputs.run_codecov }}
         with:
           file: lcov.info
+          token: ${{ secrets.codecov_token }}

template/.github/workflows/Test.yml.jinja

@@ -23,6 +23,9 @@ jobs:
       version: {% raw %}${{ matrix.version }}{% endraw %}
       arch: {% raw %}${{ matrix.arch }}{% endraw %}
       allow_failure: {% raw %}${{ matrix.allow_failure }}{% endraw %}
+      run_codecov: {% raw %}${{ matrix.version == "1" && matrix.os == "ubuntu-latest" }}{% endraw %}
+    secrets:
+      codecov_token: {% raw %}${{ secrets.CODECOV_TOKEN }}{% endraw %}
     strategy:
       fail-fast: false
       matrix:

template/.github/workflows/{% if SimplifiedPRTest %}TestOnPRs.yml{% endif %}.jinja

@@ -1,4 +1,4 @@
-name: Test
+name: Test on PRs
 
 on:
   pull_request:
@@ -24,3 +24,6 @@ jobs:
       version: "1"
       arch: x64
       allow_failure: false
+      run_codecov: true
+    secrets:
+      codecov_token: {% raw %}${{ secrets.CODECOV_TOKEN }}{% endraw %}