From 9bd0aa97f8809c2ca4327d7f0bdf099ba7d23e13 Mon Sep 17 00:00:00 2001 From: Pedro Brochado Date: Mon, 15 Apr 2024 17:19:06 -0300 Subject: [PATCH] Add support for docs-CI 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/+new-docs-ci.misc | 1 + doc_requirements.txt | 3 +++ docs/template_gitref | 2 +- template_config.yml | 2 +- 7 files changed, 16 insertions(+), 3 deletions(-) create mode 100644 CHANGES/+new-docs-ci.misc 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 a5f10b3c1..f00fa2fcf 100755 --- a/.github/workflows/scripts/script.sh +++ b/.github/workflows/scripts/script.sh @@ -31,6 +31,8 @@ if [[ "$TEST" = "docs" ]]; then if [[ "$GITHUB_WORKFLOW" == "Ansible 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 01dd7acd9..768d2b1de 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/+new-docs-ci.misc b/CHANGES/+new-docs-ci.misc new file mode 100644 index 000000000..8b1378917 --- /dev/null +++ b/CHANGES/+new-docs-ci.misc @@ -0,0 +1 @@ + diff --git a/doc_requirements.txt b/doc_requirements.txt index bd7622a47..4ca04120b 100644 --- a/doc_requirements.txt +++ b/doc_requirements.txt @@ -15,4 +15,7 @@ sphinxcontrib-jquery sphinxcontrib-openapi 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/template_gitref b/docs/template_gitref index 9ec4e6fe6..e169228ce 100644 --- a/docs/template_gitref +++ b/docs/template_gitref @@ -1 +1 @@ -2021.08.26-326-ge5addc7 +2021.08.26-327-g520b576 diff --git a/template_config.yml b/template_config.yml index 643c5e5da..2308e7c41 100644 --- a/template_config.yml +++ b/template_config.yml @@ -88,5 +88,5 @@ test_reroute: true test_s3: true use_issue_template: true use_legacy_docs: true -use_unified_docs: false +use_unified_docs: true