Merge pull request #78 from py-pkgs/patch-codecov-actions-bump

Patch codecov actions bump and update docs
py-pkgs · Jan 6, 2025 · a4078dd · a4078dd
2 parents fce21a8 + 1b6b768
commit a4078dd
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/docs/source/user-guide.md b/docs/source/user-guide.md
@@ -130,7 +130,7 @@ A GitHub Actions workflow file for continuous integration will be included in yo
 - Sets up a Ubuntu operating system, checks out your repository, installs Python 3.9, and installs the latest version of `poetry`.
 - Installs your package with `poetry install`
 - Runs test with `pytest tests/`
-- Upload code coverage of tests to Codecov
+- Upload code coverage of tests to Codecov. For this to work, you'll need to log-in to [Codecov]([https://test.pypi.org](https://about.codecov.io/), manually add and activate your project's GitHub repository on Codecov, [get the repository upload token](https://docs.codecov.com/docs/quick-start#step-2-get-the-repository-upload-token), and [add the token as a secret](https://docs.github.com/en/actions/reference/encrypted-secrets) called `CODECOV_TOKEN` to your GitHub repository.
 - Builds documentation with `sphinx`
 
 ### CI+CD (continuous integration + continuous deployment)

diff --git a/{{ cookiecutter.__package_slug }}/.github/workflows/ci-cd.yml b/{{ cookiecutter.__package_slug }}/.github/workflows/ci-cd.yml
@@ -27,9 +27,9 @@ jobs:
         run: poetry run pytest tests/ --cov={{ cookiecutter.__package_slug }} --cov-report=xml
 
       - name: Use Codecov to track coverage
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v5
         with:
-          files: ./coverage.xml   # coverage report
+          token: ${{ secrets.CODECOV_TOKEN }}
 
       - name: Build documentation
         run: poetry run make html --directory docs/

diff --git a/{{ cookiecutter.__package_slug }}/.github/workflows/ci.yml b/{{ cookiecutter.__package_slug }}/.github/workflows/ci.yml
@@ -27,9 +27,9 @@ jobs:
         run: poetry run pytest tests/ --cov={{ cookiecutter.__package_slug }} --cov-report=xml
 
       - name: Use Codecov to track coverage
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v5
         with:
-          files: ./coverage.xml # coverage report
+          token: ${{ secrets.CODECOV_TOKEN }}
 
       - name: Build documentation
         run: poetry run make html --directory docs/