From 546af83e7de78b2b1d9a3ceb740ac58f02dfe51a Mon Sep 17 00:00:00 2001 From: Pedro Brochado Date: Thu, 11 Apr 2024 13:22:19 -0300 Subject: [PATCH] Turn docs-ci on Related to: https://github.com/pulp/pulp-docs/issues/31 [noissue] --- .github/template_gitref | 2 +- .github/workflows/scripts/script.sh | 8 ++++++++ .github/workflows/test.yml | 1 + CHANGES/+docs-ci.misc | 1 + doc_requirements.txt | 21 ++++++++++++++++++--- docs/static/.gitkeep | 0 docs/template_gitref | 1 + template_config.yml | 2 +- 8 files changed, 31 insertions(+), 5 deletions(-) create mode 100644 CHANGES/+docs-ci.misc create mode 100644 docs/static/.gitkeep create mode 100644 docs/template_gitref diff --git a/.github/template_gitref b/.github/template_gitref index 9ec4e6fe6..e169228ce 100644 --- a/.github/template_gitref +++ b/.github/template_gitref @@ -1 +1 @@ -2021.08.26-326-ge5addc7 +2021.08.26-327-g520b576 diff --git a/.github/workflows/scripts/script.sh b/.github/workflows/scripts/script.sh index 31a0760a3..451cded97 100755 --- a/.github/workflows/scripts/script.sh +++ b/.github/workflows/scripts/script.sh @@ -31,6 +31,8 @@ if [[ "$TEST" = "docs" ]]; then if [[ "$GITHUB_WORKFLOW" == "Rpm CI" ]]; then towncrier build --yes --version 4.0.0.ci fi + # Unified Docs Build + pulp-docs build # Legacy Docs Build cd docs make PULP_URL="$PULP_URL" diagrams html @@ -43,6 +45,12 @@ if [[ "$TEST" = "docs" ]]; then exit fi +if [[ "$TEST" = "new_docs" ]]; then + pip install --user git+https://github.com/pulp/pulp-docs + pulp-docs build + exit +fi + REPORTED_STATUS="$(pulp status)" echo "machine pulp diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 67e08b222..190dbf735 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -23,6 +23,7 @@ jobs: env: - TEST: pulp - TEST: docs + - TEST: new_docs - TEST: azure - TEST: s3 - TEST: lowerbounds diff --git a/CHANGES/+docs-ci.misc b/CHANGES/+docs-ci.misc new file mode 100644 index 000000000..91a157185 --- /dev/null +++ b/CHANGES/+docs-ci.misc @@ -0,0 +1 @@ +Added the Unified Docs CI build-check on PRs. diff --git a/doc_requirements.txt b/doc_requirements.txt index 6e967f3e0..27fd65980 100644 --- a/doc_requirements.txt +++ b/doc_requirements.txt @@ -1,6 +1,21 @@ +# WARNING: DO NOT EDIT! +# +# This file was generated by plugin_template, and is managed by it. Please use +# './plugin-template --docs pulp_rpm' to update this file. +# +# For more info visit https://github.com/pulp/plugin_template +-r requirements.txt +towncrier + +# Legacy docs plantuml -sphinx<7.0 -sphinx-rtd-theme==1.2.0 +sphinx~=7.1.2 +sphinx-rtd-theme==1.3.0 sphinxcontrib-jquery sphinxcontrib-openapi -towncrier +mistune<4.0.0 +Jinja2<3.2 + +# Unified docs +pulp-docs @ git+https://github.com/pulp/pulp-docs@main +# Extra requirements diff --git a/docs/static/.gitkeep b/docs/static/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/docs/template_gitref b/docs/template_gitref new file mode 100644 index 000000000..e169228ce --- /dev/null +++ b/docs/template_gitref @@ -0,0 +1 @@ +2021.08.26-327-g520b576 diff --git a/template_config.yml b/template_config.yml index 1ded4ad1d..2becdfe1e 100644 --- a/template_config.yml +++ b/template_config.yml @@ -89,5 +89,5 @@ test_reroute: true test_s3: true use_issue_template: true use_legacy_docs: true -use_unified_docs: false +use_unified_docs: true