From bae29f94f562bc69485ef7a4ea5c6c7bf22ebaad Mon Sep 17 00:00:00 2001
From: Ghanshyam Mann <gmann@ghanshyammann.com>
Date: Sat, 16 Nov 2024 20:17:20 -0800
Subject: [PATCH] Migrate OpenStack tox doc jobs to Ubuntu Noble (24.04)

As per 2025.1 testing runtime[1], we need to move gate
test jobs on Ubuntu Noble (24.04).

This change migrates the OpenStack tox doc jobs to ubuntu
Noble.

This change adds the test bindep target to the docs job
openstack projects do not support the compile bindep profile
https://codesearch.opendev.org/?q=compile&i=nope&literal=nope&files=bindep.txt&excludeFiles=&repos=
they use the test target to encode the bindeps of all tox jobs including docs

[1] https://governance.openstack.org/tc/reference/runtimes/2025.1.html

Change-Id: I838d27b470560c9b613c167c5fae940f16b15d11
---
 zuul.d/jobs.yaml | 49 ++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 45 insertions(+), 4 deletions(-)

diff --git a/zuul.d/jobs.yaml b/zuul.d/jobs.yaml
index a6f50f75..52f2918b 100644
--- a/zuul.d/jobs.yaml
+++ b/zuul.d/jobs.yaml
@@ -823,7 +823,7 @@
 - job:
     name: openstack-tox-docs
     parent: opendev-tox-docs
-    nodeset: ubuntu-jammy
+    nodeset: ubuntu-noble
     description: |
       Run documentation build.
 
@@ -845,13 +845,13 @@
          :zuul:jobvar:`tox_pdf_envlist` exists.
 
     branches:
-      regex: ^stable/(victoria|wallaby|xena|yoga|zed)$
+      regex: ^stable/(victoria|wallaby|xena|yoga|zed|2023.1|2023.2|2024.1|2024.2)$
       negate: true
     required-projects:
       - name: openstack/requirements
     vars:
       tox_constraints_file: '{{ ansible_user_dir }}/src/opendev.org/openstack/requirements/upper-constraints.txt'
-      bindep_profile: compile doc
+      bindep_profile: compile test doc
       tox_envlist: docs
       tox_pdf_envlist: pdf-docs
       tox_skip_pdf: false
@@ -859,6 +859,47 @@
     pre-run: playbooks/tox-docs/pre.yaml
     run: playbooks/tox-docs/run.yaml
 
+
+- job:
+    name: openstack-tox-docs
+    parent: opendev-tox-docs
+    nodeset: ubuntu-jammy
+    description: |
+      Run documentation build.
+
+      Uses tox with the ``docs`` environment.
+
+      .. zuul:jobvar: tox_envlist
+
+         The tox environment for building HTML, default is ``docs``.
+
+      .. zuul:jobvar: tox_pdf_envlist
+
+         The tox environment for building PDF, default is ``pdf-docs``.
+         If this environment does not exist, no PDF building is done.
+
+      .. zuul:jobvar: tox_skip_pdf
+
+         Whether to skip building of PDF documents. By default a PDF
+         file is build if the tox environment specified by
+         :zuul:jobvar:`tox_pdf_envlist` exists.
+    required-projects:
+      - name: openstack/requirements
+    vars:
+      tox_constraints_file: '{{ ansible_user_dir }}/src/opendev.org/openstack/requirements/upper-constraints.txt'
+      bindep_profile: compile test doc
+      tox_envlist: docs
+      tox_pdf_envlist: pdf-docs
+      tox_skip_pdf: false
+    # PDF Building is only done from stein onwards.
+    pre-run: playbooks/tox-docs/pre.yaml
+    run: playbooks/tox-docs/run.yaml
+    branches:
+      - ^.*/2023.1
+      - ^.*/2023.2
+      - ^.*/2024.1
+      - ^.*/2024.2
+
 - job:
     name: openstack-tox-docs
     parent: opendev-tox-docs
@@ -889,7 +930,7 @@
     vars:
       tox_constraints_file: '{{ ansible_user_dir }}/src/opendev.org/openstack/requirements/upper-constraints.txt'
       tox_envlist: docs
-      bindep_profile: compile doc
+      bindep_profile: compile test doc
       tox_pdf_envlist: pdf-docs
       tox_skip_pdf: false
       # NOTE(gmann): This is stable branch (<=(stable|unmaintained)/zed) job and new