CI: Work around missing 'distutils' for Python 3.12+ (GHA round two) #795
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Older versions of node-gyp are incompatible with Python 3.12+, at least out of the box, since Python 3.12+ no-longer ship with 'distutils' out of the box. We can work around it by installing 'setuptools' package, which comes with the required 'distutils'. Newer versions of node-gyp should come with a fix for this, but older Yarn or npm will ship with older node-gyp, so here we are. Note that this isn't really needed on the ubuntu-based CI workflows for now, since those are on the rather conservatively-updated Debian/Ubuntu-packaged versions of Python (no newer than Python 3.11, at present.) But being proactive means this won't sneak up on us later.
DeeDeeG
changed the title
DeeDeeG
changed the title
confused-Techie
approved these changes
Nov 7, 2023
There was a problem hiding this comment.
Since all tests pass and this solves a current issue in our testing strategy, lets go ahead and get it merged!
Thanks for the awesome work @DeeDeeG
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Identify the Bug
The "Editor Tests" workflow is failing in GitHub Actions lately.
Similar problem as #779, but circling back around to address it on the other workflow
.ymlfiles as well.Description of the Change
Adds a step to install the
setuptoolsPython package just before any of our GitHub Actions workflows try to install dependencies.Context:
setuptoolsprovides a copy of thedistutilsmodule, whichnode-gyptries to import, but which was deprecated in recent Python versions and does not ship out of the box in Python 3.12+. There is a fix for this innode-gyp10.0, but older copies of Yarn or npm come with older node-gyp, so here we are.Alternate Designs
This fix won't actually be needed for a little while on the Ubuntu-based workflows, since those are still on Python 3.8, Python 3.10, soon to be Python 3.11... Only Python 3.12+ is affected by the issue. But doing this now means it won't come back again if/when
ubuntu-latestships Python 3.12 or newer, I guess.So, we could undo the change to
documentation.yml,package-tests-linux.ymlandvalidate-wasm-grammar-prs.ymlfor now and probably not need the change for a little while.Possible Drawbacks
This adds 6 lines to all the GitHub Actions workflow
.ymlfiles, so it might seem too verbose, more noticeable on the really short workflow files. Especially the very simple Linux-only workflows that don't need the fix immediately. Only takes a second to run, though.Verification Process
CI should pass. Specifically. the "Editor Tests" workflow on macOS should start passing with this (has been failing lately), and the other workflows shouldn't start failing due to this change.
Release Notes
N/A (CI-only change) but: Fix missing 'distutils' with Python 3.12+ in GitHub Actions (round two)