Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Patch codecov actions bump and update docs #78

Merged
merged 3 commits into from
Jan 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/user-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 2 additions & 2 deletions {{ cookiecutter.__package_slug }}/.github/workflows/ci-cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand Down
4 changes: 2 additions & 2 deletions {{ cookiecutter.__package_slug }}/.github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Loading