-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
.github: Move build-docs to his own workflow
- Loading branch information
1 parent
70667e5
commit 127b784
Showing
2 changed files
with
60 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
name: "Build docs" | ||
|
||
on: | ||
workflow_call: | ||
inputs: | ||
ref: | ||
description: "the git revision to checkout" | ||
default: ${{ github.ref }} | ||
required: false | ||
type: string | ||
secrets: | ||
ARTIFACTS_USER: | ||
required: true | ||
ARTIFACTS_PASSWORD: | ||
required: true | ||
|
||
jobs: | ||
docs: | ||
runs-on: ubuntu-20.04 | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
with: | ||
ref: ${{ inputs.ref }} | ||
- name: Install Python 3 | ||
uses: actions/setup-python@v5 | ||
with: | ||
python-version: "3.10" | ||
- name: Install deps | ||
run: | | ||
export DEBIAN_FRONTEND=noninteractive | ||
sudo apt-get update | ||
sudo apt-get install --no-install-recommends -y plantuml | ||
python3.10 -m pip install tox~=4.0.19 | ||
- name: Build documentation for ReadTheDocs | ||
env: | ||
# Fake that we are building in a ReadTheDocs environment | ||
READTHEDOCS: "True" | ||
run: tox --workdir /tmp/tox -e docs -- html | ||
- name: Copy generated docs for ReadTheDocs | ||
run: mkdir -p artifacts/docs/readthedocs && cp -r docs/_build/* artifacts/docs/readthedocs/ | ||
- name: Build documentation with Scality theme | ||
run: rm -rf docs/_build && tox --workdir /tmp/tox -e docs -- html | ||
- name: Copy generated docs with Scality theme | ||
run: cp -r docs/_build/* artifacts/docs/ && cp CHANGELOG.md artifacts/docs/ | ||
- name: Upload artifacts | ||
uses: scality/action-artifacts@v4 | ||
with: | ||
method: upload | ||
url: https://artifacts.scality.net | ||
user: ${{ secrets.ARTIFACTS_USER }} | ||
password: ${{ secrets.ARTIFACTS_PASSWORD }} | ||
source: artifacts |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters