generate-documentation.yml triggered by documentation update is broken

[pbiering]

Can anyone please support fixing this, triggered after publishing the new release:

https://github.com/Kozea/Radicale/actions/runs/11315763370/job/31467312127

Thank you!

[pbiering]

https://github.com/Kozea/Radicale/blob/gh-pages/documentation-generator/run.py need update for Ubuntu >= 24.04

[stefangehn]

I think a quick fix would be to add --break-system-packages to the pip install command in

Radicale/documentation-generator/run.py

Line 77 in e06cefe

subprocess.run([sys.executable, "-m", "pip", "install", "beautifulsoup4"],

[pbiering]

@stefangehn thank you for the hint but looks like not working

d888e09

Result:

https://github.com/Kozea/Radicale/actions/runs/11548883927

  File "/home/runner/work/Radicale/Radicale/documentation-generator/run.py", line 77, in install_dependencies
    subprocess.run([sys.executable, "-m", "pip", "install", "--break-system-packages", "beautifulsoup4"],
  File "/usr/lib/python3.10/subprocess.py", line 526, in run
    raise CalledProcessError(retcode, process.args,
subprocess.CalledProcessError: Command '['/usr/bin/python3', '-m', 'pip', 'install', '--break-system-packages', 'beautifulsoup4']' returned non-zero exit status 2.

[stefangehn]

I looked at the latest runs as well as the failing one for 3.3.0 and checked the "Set up job" step at the start and found a difference:

• It looks like 3.3.0 uses a ubuntu-24.04 docker with Python 3.12 and its pip refuses to install system-wide packages by default (you are supposed to use either a venv for deps or accept the possible breakage via the switch)
• The last few builds use a ubuntu-22.04 docker image with Python 3.10 and its pip does not know the switch yet

I don't know why ubuntu-latest would seemingly use different ubuntu releases. At most a name like "latest" would imply to me that it would eventually upgrade from 22.04 to 24.04 at some point but then also keep using that new version.

[stefangehn]

Found https://github.blog/changelog/2024-09-25-actions-new-images-and-ubuntu-latest-changes/
Maybe changing the workflow to ubuntu-22.04 for the time being makes this more reproducible.

[pbiering]

Maybe changing the workflow to ubuntu-22.04 for the time being makes this more reproducible.

This is the current state in "upstream", but a fix is required latest when ubuntu-22.04 is no longer available.

[stefangehn]

Using the switch (or a venv) together with switching to ubuntu-24.04 should work as well and would indeed be more future-proof.

I hope the random behavior of ubuntu-latest referring to different Ubuntu images is just a temporary hickup that will go away in a few weeks (could very well be a caching issue on GH provided runners, hard to tell from the run logs)