Skip to content

Commit 5995600

Browse files
committed
Add unified docs-ci
Related to: pulp/pulp-docs#31 [noissue]
1 parent 01a18cb commit 5995600

File tree

4 files changed

+37
-2
lines changed

4 files changed

+37
-2
lines changed

.github/workflows/ci.yml

+7-2
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,15 @@ jobs:
3232
pip install requests
3333
sh .github/workflows/scripts/check_commit.sh
3434
35+
docs:
36+
uses: "./.github/workflows/docs-ci.yml"
37+
3538
pulp:
3639
runs-on: ubuntu-latest
37-
# run only after lint finishes
38-
needs: lint
40+
# run only after lint and docs finishes
41+
needs:
42+
- lint
43+
- docs
3944
strategy:
4045
fail-fast: false
4146
matrix:

.github/workflows/docs-ci.yml

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: "Docs CI"
2+
3+
on:
4+
workflow_call:
5+
6+
jobs:
7+
test:
8+
runs-on: "ubuntu-20.04"
9+
steps:
10+
- uses: "actions/checkout@v4"
11+
- name: "Set up Python"
12+
uses: "actions/setup-python@v5"
13+
with:
14+
python-version: "3.11"
15+
- name: "Install Test Dependencies"
16+
run: |
17+
pip install -r doc_requirements.txt
18+
- name: Build docs
19+
run: make docs

Makefile

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
help: ## Show this help.
2+
@sed -ne '/@sed/!s/## //p' $(MAKEFILE_LIST)
3+
4+
docs: ## Build unified docs.
5+
pulp-docs build
6+
7+
servedocs: ## Serves unified docs.
8+
pulp-docs serve
9+
10+
.PHONY: docs servedocs help

doc_requirements.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
pulp-docs @ git+https://github.com/pulp/pulp-docs@main

0 commit comments

Comments
 (0)