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

Github actions docs use different versions in matrix.os #1612

Closed
rogerbinns opened this issue Sep 13, 2023 · 3 comments · Fixed by #1734
Closed

Github actions docs use different versions in matrix.os #1612

rogerbinns opened this issue Sep 13, 2023 · 3 comments · Fixed by #1734

Comments

@rogerbinns
Copy link

Description

There is a github action shown in the main doc at https://cibuildwheel.readthedocs.io/en/stable/setup/#github-actions

It points to a more complete example at https://github.com/pypa/cibuildwheel/blob/main/examples/github-deploy.yml

They have differences in matrix.os:

 os: [ubuntu-20.04, windows-2019, macos-11]

 os: [ubuntu-22.04, windows-2022, macos-11]

There are a few other spots where matrix.os is present like here. It would be really nice if the doc only had the recommend set which is presumably the newer versions.

Build log

No response

CI config

No response

@henryiii
Copy link
Contributor

henryiii commented Sep 13, 2023

@joerick would you be okay if we just update to using -latest everywhere? We aren't going to remember to update it, users aren't going to remember to update it, and Dependabot can't do it for you (as far as I know...). If someone does want to pin things down, they can look up the current version, and quite a good percentage of the time1 it's not important. And it's important we catch breaking updates in our tests first, too.

Footnotes

  1. There are sometimes things that matter a bit, like MSVC's 2019 update, but some of these things update in the "fixed" images anyway.

@rogerbinns
Copy link
Author

Relevant to Dependabot, every time I apply a new cibuildwheel release I have been going in and manually making my github actions workflows match the examples in the cibuildwheel doc. That is why I spotted this. Over time the examples have been getting smaller which is great. But I can't see a way that could be automated - for example recent changes have including not naming the artifacts "wheelhouse" any more, but automating that change would be delicate.

@joerick
Copy link
Contributor

joerick commented Sep 18, 2023

Yeah, I think we could switch to just using/documenting -latest nowadays. I feel like the hassle of updating these pins is worse than the risk of stuff changing. Besides, as you say, the pins aren't really pins, GH still update the images all the time.

rogerbinns added a commit to rogerbinns/apsw that referenced this issue Nov 1, 2023
joerick added a commit that referenced this issue Jan 27, 2024
Fix #1612

The hassle of updating these pins (both for us and our users, most copy our documentation) seems to outweigh the benefit of the pin. The truth is that they're not really pins anyway, Github update them all the time, and they don't work for historical repeatability because old images are retired all the time.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants