Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add unified docs-ci #97

Merged
merged 1 commit into from
May 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 7 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,15 @@ jobs:
pip install requests
sh .github/workflows/scripts/check_commit.sh

docs:
uses: "./.github/workflows/docs-ci.yml"

pulp:
runs-on: ubuntu-latest
# run only after lint finishes
needs: lint
# run only after lint and docs finishes
needs:
- lint
- docs
strategy:
fail-fast: false
matrix:
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
10 changes: 10 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -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
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