Skip to content

CASSJAVA-109, CASSJAVA-117: Manual and API References after donation, Build CI for Java Driver Doc: #1

CASSJAVA-109, CASSJAVA-117: Manual and API References after donation, Build CI for Java Driver Doc:

CASSJAVA-109, CASSJAVA-117: Manual and API References after donation, Build CI for Java Driver Doc: #1

name: Build docs and upload ZIP
on:
push:
branches:
- 4.x
pull_request:
branches:
- 4.x
workflow_dispatch:
jobs:
build-docs:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
# 1. Checkout current branch
- name: Checkout current branch
uses: actions/checkout@v4
# 2. Java 8 (with Maven cache)
- name: Set up Java 8
uses: actions/setup-java@v4
with:
distribution: temurin
java-version: "8"
cache: maven # <--- cache Maven deps (~/.m2/repository)
# 3. Python 3.10.19
- name: Set up Python 3.10.19
uses: actions/setup-python@v5
with:
python-version: "3.10.19"
# 4. Install MkDocs dependencies
- name: Install MkDocs dependencies
run: |
python -m pip install --upgrade pip
pip install \
mkdocs \
mkdocs-material \
mkdocs-awesome-pages-plugin \
mkdocs-macros-plugin
# 5. Build docs via build-doc.sh
- name: Build documentation
run: |
chmod +x ./build-doc.sh
./build-doc.sh
# 6. Upload built docs as a ZIP artifact
- name: Archive built documentation
run: |
zip -r docs-built.zip docs
- name: Upload built doc artifact
uses: actions/upload-artifact@v4
with:
name: built-docs-zip
path: docs-built.zip
retention-days: 10