Skip to content

Commit

Permalink
Add unified docs-ci
Browse files Browse the repository at this point in the history
Related to: pulp/pulp-docs#31

[noissue]
  • Loading branch information
pedro-psb committed Apr 16, 2024
1 parent 21b4961 commit 3a13b5e
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ jobs:
run: |
make fmt vet
shell: bash
docs:
uses: "./.github/workflows/docs-ci.yml"
bundle:
runs-on: ubuntu-latest
steps:
Expand Down
19 changes: 19 additions & 0 deletions .github/workflows/docs-ci.yml
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions CHANGES/+new-docs-ci.misc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added the Unified Docs CI build-check on PRs.
8 changes: 8 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions doc_requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
pulp-docs @ git+https://github.com/pulp/pulp-docs@main

0 comments on commit 3a13b5e

Please sign in to comment.