From 3a13b5e07053487d055f37f25ce08ad875bcd499 Mon Sep 17 00:00:00 2001 From: Pedro Brochado Date: Tue, 16 Apr 2024 15:48:59 -0300 Subject: [PATCH] Add unified docs-ci Related to: https://github.com/pulp/pulp-docs/issues/31 [noissue] --- .github/workflows/ci.yml | 2 ++ .github/workflows/docs-ci.yml | 19 +++++++++++++++++++ CHANGES/+new-docs-ci.misc | 1 + Makefile | 8 ++++++++ doc_requirements.txt | 1 + 5 files changed, 31 insertions(+) create mode 100644 .github/workflows/docs-ci.yml create mode 100644 CHANGES/+new-docs-ci.misc create mode 100644 doc_requirements.txt diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 647affe51..67b9184ad 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -55,6 +55,8 @@ jobs: run: | make fmt vet shell: bash + docs: + uses: "./.github/workflows/docs-ci.yml" bundle: runs-on: ubuntu-latest steps: diff --git a/.github/workflows/docs-ci.yml b/.github/workflows/docs-ci.yml new file mode 100644 index 000000000..ccd6215ed --- /dev/null +++ b/.github/workflows/docs-ci.yml @@ -0,0 +1,19 @@ +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/CHANGES/+new-docs-ci.misc b/CHANGES/+new-docs-ci.misc new file mode 100644 index 000000000..91a157185 --- /dev/null +++ b/CHANGES/+new-docs-ci.misc @@ -0,0 +1 @@ +Added the Unified Docs CI build-check on PRs. diff --git a/Makefile b/Makefile index 2fa2299ef..df9a84dbd 100644 --- a/Makefile +++ b/Makefile @@ -151,6 +151,14 @@ ifeq ($(shell which go 2>/dev/null), ) tar -C $(GOLANG_INSTALL_PATH) -xzf golang.tar.gz endif +.PHONY: docs +docs: ## Build unified docs + pulp-docs build + +.PHONY: servedocs +servedocs: ## Build unified docs + pulp-docs serve + ##@ Build .PHONY: build diff --git a/doc_requirements.txt b/doc_requirements.txt new file mode 100644 index 000000000..60e329d95 --- /dev/null +++ b/doc_requirements.txt @@ -0,0 +1 @@ +pulp-docs @ git+https://github.com/pulp/pulp-docs@main