Compare commits

..

2 Commits

Author SHA1 Message Date
03ecab9755 Rename tox target for pdf build
All checks were successful
gl/check check status: success (03ecab9755562d7f4efc3c3b914b787c73a48eb8)
zuul jobs require target to be called pdf-docs instead of docs-pdf
2023-03-23 12:37:25 +01:00
ec59663c39 Include pdf filenames into zuul config
Zuul jobs expect to know PDF filenames to be fetching from artifacts.
Best way is to include them into the project config while managing zuul
config.
2023-03-23 12:37:25 +01:00
3 changed files with 12 additions and 56 deletions

View File

@ -198,20 +198,6 @@ documents:
service_type: cts
title: User Guide
type: umn
- html_location: docs/dbss/api-ref
link: /database-security-service/api-ref/
pdf_name: dbss-api-ref
rst_location: api-ref/source
service_type: dbss
title: API Reference
type: api-ref
- html_location: docs/dbss/umn
link: /database-security-service/umn/
pdf_name: dbss-umn
rst_location: umn/source
service_type: dbss
title: User Guide
type: umn
- hc_location: api/dc
html_location: docs/dc/api-ref
link: /direct-connect/api-ref/
@ -476,20 +462,6 @@ documents:
service_type: elb
title: User Guide
type: umn
- html_location: docs/er/api-ref
link: /enterprise-router/api-ref/
pdf_name: er-api-ref
rst_location: api-ref/source
service_type: er
title: API Reference
type: api-ref
- html_location: docs/er/umn
link: /enterprise-router/umn/
pdf_name: er-umn
rst_location: umn/source
service_type: er
title: User Guide
type: umn
- hc_location: api/evs
html_location: docs/evs/api-ref
link: /elastic-volume-service/api-ref/
@ -1193,19 +1165,6 @@ services:
teams:
- name: docs-orchestration-rw
permission: write
- repositories:
- environment: internal
repo: docs/database-security-service
type: gitea
- environment: public
repo: opentelekomcloud-docs/database-security-service
type: github
service_category: security-services
service_title: Database Security Service
service_type: dbss
teams:
- name: docs-security-services-rw
permission: write
- repositories:
- environment: internal
repo: docs/direct-connect
@ -1408,19 +1367,6 @@ services:
teams:
- name: docs-network-rw
permission: write
- repositories:
- environment: internal
repo: docs/enterprise-router
type: gitea
- environment: public
repo: opentelekomcloud-docs/enterprise-router
type: github
service_category: network
service_title: Enterprise Router
service_type: er
teams:
- name: docs-network-rw
permission: write
- repositories:
- environment: internal
repo: docs/elastic-volume-service

View File

@ -35,7 +35,7 @@ commands =
{[testenv:json-{{ doc.type }}]commands}
{%- endfor %}
[testenv:docs-pdf]
[testenv:pdf-docs]
deps = -r{toxinidir}/doc/requirements.txt
allowlist_externals =
rm

View File

@ -130,6 +130,7 @@ def process_repositories(args, service):
zuul_templates = None
zuul_jobs = dict()
zuul_new_jobs = list()
zuul_vars = dict()
zuul_config_updated = False
for item in zuul_config:
if "project" in item.keys():
@ -137,10 +138,11 @@ def process_repositories(args, service):
zuul_templates = project.setdefault("templates", [])
if not zuul_templates:
zuul_templates = []
zuul_vars = project.setdefault("vars", {})
elif "job" in item.keys():
job = item["job"]
zuul_jobs[job["name"]] = job
print(f"Existing jobs {zuul_jobs}")
logging.debug(f"Existing jobs {zuul_jobs}")
if "helpcenter-base-jobs" not in zuul_templates:
zuul_templates.append("helpcenter-base-jobs")
zuul_config_updated = True
@ -148,6 +150,7 @@ def process_repositories(args, service):
job_suffix = (
"-hc-int-jobs" if args.environment == "internal" else "-hc-jobs"
)
sphinx_pdf_files = zuul_vars.setdefault('sphinx_pdf_files', [])
for doc in data.docs_by_service_type(service["service_type"]):
logging.debug(f"Analyzing document {doc}")
if not doc.get("type"):
@ -156,6 +159,12 @@ def process_repositories(args, service):
doc_type = "dev-guide"
else:
doc_type = doc["type"]
# Collect all PDF files into sphinx_pdf_files var
pdf_name = doc.get('pdf_name')
if pdf_name and f"{pdf_name}.pdf" not in sphinx_pdf_files:
sphinx_pdf_files.append(f"{pdf_name}.pdf")
zuul_config_updated = True
template_name = f"{doc_type}{job_suffix}"
if doc_type in ["api-ref", "umn", "dev-guide"]:
if template_name not in zuul_templates:
@ -190,6 +199,7 @@ def process_repositories(args, service):
if "project" in item.keys():
project = item["project"]
project["templates"] = zuul_templates
project["vars"] = zuul_vars
# Ensure new jobs are in check
if len(zuul_new_jobs) > 0:
project.setdefault(