From 42028c696a0a6ccc42fe97a3c3819735d5a1db2b Mon Sep 17 00:00:00 2001 From: Pedro Brochado Date: Tue, 16 Apr 2024 15:37:00 -0300 Subject: [PATCH] Add unified docs-ci Related to: https://github.com/pulp/pulp-docs/issues/31 [noissue] --- .github/workflows/ci.yml | 6 +++++- .github/workflows/docs-ci.yml | 20 ++++++++++++++++++++ Makefile | 10 ++++++++++ doc_requirements.txt | 1 + 4 files changed, 36 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/docs-ci.yml create mode 100644 Makefile create mode 100644 doc_requirements.txt diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 575f3b95..af5820bc 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -41,8 +41,12 @@ jobs: done shell: bash - base-images: + docs: needs: lint + uses: "./.github/workflows/docs-ci.yml" + + base-images: + needs: docs runs-on: ubuntu-latest outputs: image_variants: "${{ steps.image_variants.outputs.image_variants }}" diff --git a/.github/workflows/docs-ci.yml b/.github/workflows/docs-ci.yml new file mode 100644 index 00000000..90c3c4b3 --- /dev/null +++ b/.github/workflows/docs-ci.yml @@ -0,0 +1,20 @@ +name: "Docs CI" + +on: + workflow_call: + +jobs: + test: + runs-on: "ubuntu-20.04" + steps: + - uses: "actions/checkout@v4" + - name: "Set up Python" + uses: "actions/setup-python@v5" + with: + python-version: "3.11" + - name: "Install Test Dependencies" + run: | + pip install -r doc_requirements.txt + - name: Build docs + run: make docs + diff --git a/Makefile b/Makefile new file mode 100644 index 00000000..6c56b204 --- /dev/null +++ b/Makefile @@ -0,0 +1,10 @@ +help: ## Show this help. + @sed -ne '/@sed/!s/## //p' $(MAKEFILE_LIST) + +docs: ## Build unified docs + pulp-docs build + +servedocs: ## Serves unified docs + pulp-docs serve + +.PHONY: docs servedocs help diff --git a/doc_requirements.txt b/doc_requirements.txt new file mode 100644 index 00000000..60e329d9 --- /dev/null +++ b/doc_requirements.txt @@ -0,0 +1 @@ +pulp-docs @ git+https://github.com/pulp/pulp-docs@main