Skip to content

Test docs & gallery on Windows (Azure) only for main#7658

Closed
lagru wants to merge 1 commit intoscikit-image:mainfrom
lagru:no-win-docs-on-prs
Closed

Test docs & gallery on Windows (Azure) only for main#7658
lagru wants to merge 1 commit intoscikit-image:mainfrom
lagru:no-win-docs-on-prs

Conversation

@lagru
Copy link
Member

@lagru lagru commented Jan 12, 2025

Description

The Azure jobs testing our documentation are still the longest running jobs in our CI: ~40 min or longer. As a first step, I'd like to exclude them from running for every PR. That should get the iteration time for PRs down to 20 min (building the package will be the biggest contributor to runtime after than).

@stefanv, suggested to disable them altogether. I'm not sure yet how I feel about that. Since we have contributors on Windows, I do want to ensure that that building the docs locally keeps working for them.

So for now, I propose this compromise which skips in PRs and keeps building the docs on main.

Checklist

Release note

For maintainers and optionally contributors, please refer to the instructions on how to document this PR for the release notes.

...

@lagru lagru added the 🤖 type: Infrastructure CI, packaging, tools and automation label Jan 12, 2025
The Azure jobs testing our documentation are still the longest running
jobs in our CI: ~40 min or longer. As a first step, I'd like to exclude
them from running for every PR. That should get the iteration time for
PRs down to 20 min.

@stefanv, suggested to disable them altogether. I'm not sure yet how I
feel about that. Since we do still tell contributors how to build the
docs on Windows, I do want to ensure that that keeps working. So for
now, I propose this compromise which keeps building the docs on `main`.
@lagru lagru force-pushed the no-win-docs-on-prs branch from 588de2a to ba1ac26 Compare January 12, 2025 18:22
Copy link
Member

@mkcor mkcor left a comment

Choose a reason for hiding this comment

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

This compromise sounds reasonable to me.

@lagru
Copy link
Member Author

lagru commented Jan 14, 2025

Note also the comment thread on lagru@588de2a#commitcomment-151225646 which is not visible in this PR.

@mkcor mkcor requested a review from stefanv January 23, 2025 14:57
@jarrodmillman
Copy link
Contributor

I would prefer disabling them to only running them on main or just running a cron job. I don't think it makes sense to only run certain tests after we merge to main.

@lagru
Copy link
Member Author

lagru commented Jan 24, 2025

While get that, I really don't want to end up debugging what's going wrong with some contributor trying to build the docs on Windows down the line. Or even worse, dissuade them from contributing because they are frustrated with part the contribution guide being broken for them.

Since the status quo has been testing the docs on Windows for a long time now, could we perhaps try this compromise as a first step and see how we fare? We can very easily remove them later on. The reverse might not be as trivial after some time...

@lagru
Copy link
Member Author

lagru commented Feb 3, 2025

Obsolete now with recent switch from Azure to GitLab's CI. 🥳

@lagru lagru closed this Feb 3, 2025
@lagru lagru deleted the no-win-docs-on-prs branch February 3, 2025 17:30
@lagru
Copy link
Member Author

lagru commented Feb 3, 2025

Even though, as I notice, we are currently not testing the docs on Windows at all. Not my default choice but it doesn't seem like a big priority compared to other bigger fish. 😉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🤖 type: Infrastructure CI, packaging, tools and automation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants