Skip to content

fix: run c.i. checks when PRs are merged #428

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.

Sign up for GitHub

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

Closed
CalMacCQ wants to merge 1 commit into from
Closed

fix: run c.i. checks when PRs are merged #428

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 4 additions & 2 deletions .github/workflows/check-docs-build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
name: check docs build

on:
push:
branches: [ "main" ]
Copy link
Collaborator

@cqc-alec cqc-alec Jan 7, 2025

Choose a reason for hiding this comment

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

What do we gain from this? Won't we just be repeating the tests that were run for the PR?

Copy link
Collaborator Author

@CalMacCQ CalMacCQ Jan 10, 2025

Choose a reason for hiding this comment

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

This was more to bring the C.I. checks in line with what happens on other repositories. Unless I'm mistaken the docs build is tested for other pytket repos when commits are pushed to a branch in a PR and also when the PR is merged. At present only the former happens for pytket-docs.

Copy link
Collaborator

@cqc-alec cqc-alec Jan 10, 2025

Choose a reason for hiding this comment

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

Looks like for pytket it is only run for pull_request and workflow_dispatch. https://github.com/CQCL/tket/blob/75d584f615d0de8129eb8f147222505f0ebdb2de/.github/workflows/build_and_test.yml#L315

It may be different on other repos, in which case perhaps we should change that. I don't see any point in running the check twice on exactly the same code...

Copy link
Collaborator Author

@CalMacCQ CalMacCQ Jan 10, 2025

Choose a reason for hiding this comment

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

I see. Looking at the workflow for the extensions it seems it works in the way I thought?
https://github.com/CQCL/pytket-quantinuum/blob/main/.github/workflows/build_and_test.yml

I don't have a strong opinion either way... was only doing this for consistency. Fine with closing this if its unecessary.

Copy link
Collaborator

@cqc-alec cqc-alec Jan 10, 2025

Choose a reason for hiding this comment

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

Even on that one the docs build is only run for pull_request and schedule triggers: https://github.com/CQCL/pytket-quantinuum/blob/42cd71c7d581c6c94bd3cde759673ce73c18a3a1/.github/workflows/build_and_test.yml#L148

For other unit tests I think we run using different Python versions on push to main, which is a compromise between thoroughness and saving time. But for the docs build I assume we only need to test with one Python version.

pull_request:
branches:
- main
branches: [ "main" ]

schedule:
# 03:00 every Saturday morning
- cron: '0 3 * * 6'
Expand Down