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

Add pytest coverage workflow & improve test config #118

Merged
merged 2 commits into from
Dec 24, 2024

Conversation

douglatornell
Copy link
Member

@douglatornell douglatornell commented Dec 23, 2024

Summary

This Pull Request introduces changes to support testing in new Python versions by defining environments, updating documentation, and configuring a CI workflow.

  • Added a GitHub Actions workflow (pytest-with-coverage.yaml) to test the project with Python 3.11 and 3.12 using a new Conda environment.
  • Updated the documentation to include instructions for updated testing and coverage analysis, including details about pytest-cov.
  • Modified the development Conda environment (environment-dev.yaml) to include pytest-cov and updated Python and Sphinx dependencies.
  • Added a new testing-specific Conda environment (environment-test.yaml) designed for use in GitHub Actions.

Introduced a GitHub Actions workflow for running tests with coverage
analysis on Python 3.11 and 3.12. Updated test environment files and
documentation to use `pytest-cov` for streamlined coverage reporting. Added
continuous integration details to the development documentation.
@douglatornell douglatornell added documentation Improvements or additions to documentation SalishSeaTools maintenance Codebase & repo maintenance labels Dec 23, 2024
@douglatornell douglatornell added this to the v24.1 milestone Dec 23, 2024
Corrected the `conda-env-file` path to reference the accurate location
within the `SalishSeaTools` directory. This ensures the CI workflow properly
identifies and uses the specified environment file.
Copy link

codecov bot commented Dec 23, 2024

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

@douglatornell douglatornell merged commit e1dafa6 into main Dec 24, 2024
7 checks passed
@douglatornell douglatornell deleted the add-pytest-with-coverage branch December 24, 2024 00:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation maintenance Codebase & repo maintenance SalishSeaTools
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant