[stable] sphinx docs jobs fail on old stable branches (no more py2 support)
Hi stable maintainers,
This mail is about to get some attention to build-openstack-sphinx-docs job that recently started to fail on old stable branches (Queens and Pike) and block gates for about ~30 repositories. (The failures are also visible in periodic stable jobs). This is because py27 support from sphinx jobs were removed [1] recently. (Python 3 (py35) support was mostly done in Rocky so that branch is not affected)
To unblock the gates I see the following options:
1. fix sphinx jobs to work with py35 (most probably requires some patches to backport - in a squashed patch - and maybe some resolution of requirement conflicts)
2. set sphinx jobs to non-voting (even better to remove them to do not use resources unnecessarily)
3. revert the patch [1] that removed the py2 support of sphinx (maybe the easiest thing to do, though i understand that py2 support is something that shouldn't be kept forever)
4. teams examine their old branches and if they are not really maintained, haven't merged patches recently, then probably it is a good time to propose their EOL transition according to the EOL process [1]
Some additional thoughts: - When Extended Maintenance was introduced the community agreed that certain CI jobs can be removed, CI coverage can be reduced as time goes. - To keep open an old branch in Extended Maintenance helps the cooperation between vendors / users as instead of maintaining it by themselves it can be done with a common effort, which could be beneficial for everyone. On the other hand, if there are no maintainers or invested efforts to keep the branch and CI alive, then it is a reasonable decision to transition the branch to End of Life.
Please consider the above options and act to eliminate the gate failures / periodic stable job failures.
[1] https://review.opendev.org/c/zuul/zuul-jobs/+/827588 https://review.opendev.org/#/q/I98c3da5b02a4ac7fb9d7bd8e00170762e77b9f40[2] https://docs.openstack.org/project-team-guide/stable-branches.html#end-of-li...
Thanks,
Előd
On 2022-02-08 12:17:28 +0100 (+0100), Előd Illés wrote: [...]
- revert the patch [1] that removed the py2 support of sphinx (maybe the
easiest thing to do, though i understand that py2 support is something that shouldn't be kept forever)
[...]
[...]
There are also some middle-ground options:
Because the primary impetus of that change was that the ensure-sphinx role was installing Sphinx with Python 2 by default, and required explicit overriding of the sphinx_python rolevar by any consumers wishing to use a modern Python interpreter to do documentation builds, it's possible the Zuul maintainers would agree to revert it while switching the default sphinx_python to python3. If they agree, I expect they'd want to set a deprecation timer to remove it at some point in the future, so would still need to address this problem sooner or later.
We could also copy the old role into the openstack-zuul-jobs repo and use that, though we'd be forking from the zuul-jobs version and taking on future maintenance of ours in the OpenStack community (at least until we can safely drop Python 2.7 support and switch back to the proper role again).
It's worth noting, that change brought something else to light... our translation import jobs, which never overrode sphinx_python, were using Python 2.7 all this time. There's some brainstorming underway now to try and figure out how to squash the bitrot which has accumulated there as a result.
participants (2)
-
Előd Illés
-
Jeremy Stanley