From e18a2f7fd5e59af8742fd8510b0a290b83886140 Mon Sep 17 00:00:00 2001 From: Ivan Cao-Berg Date: Thu, 13 Nov 2025 19:30:10 -0500 Subject: [PATCH 1/3] Added GitHub Actions --- .github/workflows/build-docs.yml | 41 ++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 .github/workflows/build-docs.yml diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml new file mode 100644 index 0000000..fb2bed3 --- /dev/null +++ b/.github/workflows/build-docs.yml @@ -0,0 +1,41 @@ +name: Build Sphinx Documentation + +on: + push: + branches: [ '*' ] + workflow_dispatch: + +permissions: + contents: read + +jobs: + build-docs: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + cache: "pip" + cache-dependency-path: "requirements.txt" + + - name: Install documentation requirements + run: | + python -m pip install --upgrade pip + pip install -r requirements.txt + + - name: Build the Sphinx HTML documentation + run: | + make -C docs html + + - name: Upload built documentation + uses: actions/upload-artifact@v4 + with: + name: docs-html + path: docs/build/html + if-no-files-found: error + retention-days: 7 From de00b9597077dd56ba61fc704fe22890506c1376 Mon Sep 17 00:00:00 2001 From: Ivan Cao-Berg Date: Thu, 13 Nov 2025 19:35:56 -0500 Subject: [PATCH 2/3] Updated GitHub Action --- .github/workflows/build-docs.yml | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml index fb2bed3..95711ee 100644 --- a/.github/workflows/build-docs.yml +++ b/.github/workflows/build-docs.yml @@ -2,7 +2,7 @@ name: Build Sphinx Documentation on: push: - branches: [ '*' ] + branches: [ "*" ] # Run on every branch workflow_dispatch: permissions: @@ -28,14 +28,22 @@ jobs: python -m pip install --upgrade pip pip install -r requirements.txt - - name: Build the Sphinx HTML documentation + - name: Build HTML documentation run: | make -C docs html - - name: Upload built documentation + - name: Create dated ZIP file + run: | + DATE=$(date +"%Y%m%d") + ZIPFILE="lane-cluster-docs-${DATE}.zip" + cd docs/build/html + zip -r "../../${ZIPFILE}" . + shell: bash + + - name: Upload ZIP artifact uses: actions/upload-artifact@v4 with: - name: docs-html - path: docs/build/html + name: built-docs-zip + path: docs/build/*.zip if-no-files-found: error retention-days: 7 From c37c326c0e2163f8db8fcd3aa3f71b72d95d9644 Mon Sep 17 00:00:00 2001 From: Ivan Cao-Berg Date: Thu, 13 Nov 2025 19:40:55 -0500 Subject: [PATCH 3/3] Updated GitHub Action --- .github/workflows/build-docs.yml | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml index 95711ee..af22980 100644 --- a/.github/workflows/build-docs.yml +++ b/.github/workflows/build-docs.yml @@ -33,17 +33,18 @@ jobs: make -C docs html - name: Create dated ZIP file + shell: bash run: | - DATE=$(date +"%Y%m%d") - ZIPFILE="lane-cluster-docs-${DATE}.zip" + DATE="$(date +%Y%m%d)" + ZIPFILE="docs-${DATE}.zip" cd docs/build/html - zip -r "../../${ZIPFILE}" . - shell: bash + # creates docs/build/docs-YYYYMMDD.zip + zip -r "../${ZIPFILE}" . - name: Upload ZIP artifact uses: actions/upload-artifact@v4 with: - name: built-docs-zip - path: docs/build/*.zip + name: docs-zip-${{ github.ref_name }} + path: docs/build/docs-*.zip if-no-files-found: error retention-days: 7