Skip to content

Add a coverage test when pushing to master#5265

Open
GarethCabournDavies wants to merge 9 commits into
gwastro:masterfrom
GarethCabournDavies:coverage
Open

Add a coverage test when pushing to master#5265
GarethCabournDavies wants to merge 9 commits into
gwastro:masterfrom
GarethCabournDavies:coverage

Conversation

@GarethCabournDavies

Copy link
Copy Markdown
Contributor

Add a coverage test. So that it isn't run too often, Ive set it so that it will run on pushes to master rather than for all events in a PR (unless its got a specific label, I think I set this up correctly)

This is largely based on the process used by gwpy

Standard information about the request

This is a new feature in the CI

This changehas been proposed using the contribution guidelines

Motivation

So that we are regularly reminded of the importance of testing!

Contents

A new GitHub job

Testing performed

The coverage test works locally and produces a html page with a table of the coverage for each module under pycbc. I have no idea if it will run in the CI, as I think this will use the rules of master to decide whether to turn the test or not, for a test which doesn't exist in master

  • The author of this pull request confirms they will adhere to the code of conduct

@GarethCabournDavies GarethCabournDavies added the coverage This PR requires the coverage tests to be run before merging label Jan 23, 2026
Copilot AI review requested due to automatic review settings January 23, 2026 16:56
@GarethCabournDavies GarethCabournDavies added code-quality Improvements to code quality github_actions Pull requests that update GitHub Actions code labels Jan 23, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds a code coverage test job to the GitHub Actions CI workflow. The coverage job is configured to run on pushes to the master branch or on pull requests that have been labeled with 'coverage', allowing coverage testing without running it on every PR event.

Changes:

  • Renamed workflow from "Flake8 check" to "Code quality checks"
  • Modified workflow triggers to run on push to master and various PR events
  • Added a new coverage job that installs dependencies, runs tests with coverage tracking, generates an HTML report, and uploads it as an artifact

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .github/workflows/check_code.yml Outdated
Comment thread .github/workflows/check_code.yml Outdated
Comment thread .github/workflows/check_code.yml
Comment thread .github/workflows/check_code.yml
Comment thread .github/workflows/check_code.yml
@GarethCabournDavies
GarethCabournDavies force-pushed the coverage branch 2 times, most recently from de4f9be to 232573b Compare January 26, 2026 15:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

code-quality Improvements to code quality coverage This PR requires the coverage tests to be run before merging github_actions Pull requests that update GitHub Actions code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants