From 5e43f149b513b404ef14995c9d753fe488d40320 Mon Sep 17 00:00:00 2001 From: eecavanna Date: Tue, 15 Oct 2024 23:26:27 -0700 Subject: [PATCH] Incorporate NMDC Runtime documentation into GitHub Pages site --- .github/workflows/deploy-to-gh-pages.yml | 5 +++++ .../fetch-and-compile-nmdc-runtime-documentation.yml | 4 +++- content/index.html | 2 +- 3 files changed, 9 insertions(+), 2 deletions(-) diff --git a/.github/workflows/deploy-to-gh-pages.yml b/.github/workflows/deploy-to-gh-pages.yml index 120884d..d744d62 100644 --- a/.github/workflows/deploy-to-gh-pages.yml +++ b/.github/workflows/deploy-to-gh-pages.yml @@ -20,6 +20,9 @@ jobs: compile-legacy-workflow-documentation: name: Compile legacy workflow documentation uses: ./.github/workflows/compile-legacy-workflow-documentation.yml + fetch-and-compile-nmdc-runtime-documentation: + name: Fetch and compile NMDC Runtime documentation + uses: ./.github/workflows/fetch-and-compile-nmdc-runtime-documentation.yml build: name: Compile main website @@ -28,6 +31,7 @@ jobs: needs: - compile-legacy-nmdc-documentation - compile-legacy-workflow-documentation + - fetch-and-compile-nmdc-runtime-documentation runs-on: ubuntu-latest permissions: contents: read @@ -44,6 +48,7 @@ jobs: mkdir -p _build/html _build/html/legacy cp -R artifacts/legacy-nmdc-documentation-as-html _build/html/legacy/nmdc-documentation cp -R artifacts/legacy-workflow-documentation-as-html _build/html/legacy/workflow-documentation + cp -R artifacts/nmdc-runtime-documentation-as-html _build/html/nmdc-runtime-documentation cp content/index.html _build/html/index.html - name: Save the result for publishing to GitHub Pages # Docs: https://github.com/actions/upload-pages-artifact uses: actions/upload-pages-artifact@v3 diff --git a/.github/workflows/fetch-and-compile-nmdc-runtime-documentation.yml b/.github/workflows/fetch-and-compile-nmdc-runtime-documentation.yml index 0ed5f73..000d95b 100644 --- a/.github/workflows/fetch-and-compile-nmdc-runtime-documentation.yml +++ b/.github/workflows/fetch-and-compile-nmdc-runtime-documentation.yml @@ -48,6 +48,8 @@ jobs: uses: actions/upload-artifact@v4 with: name: nmdc-runtime-documentation-as-html - path: ${{ github.workspace }}/_dist + # Note: Relative `path` values here are relative to the _workspace_, not to the current working directory. + # Reference: https://github.com/actions/upload-artifact/pull/477#issue-2044900649 + path: _dist if-no-files-found: error retention-days: 1 # Note: 1 day is the shortest period possible diff --git a/content/index.html b/content/index.html index 7cc8109..b941345 100644 --- a/content/index.html +++ b/content/index.html @@ -10,7 +10,7 @@

Docs

This page is a placeholder.

Current documentation

Legacy documentation