Incorporate NMDC Runtime documentation into GitHub Pages site

microbiomedata · Oct 17, 2024 · 5e43f14 · 5e43f14
1 parent cdc2a76
commit 5e43f14
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git 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
@@ -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
@@ -10,7 +10,7 @@ <h1>Docs</h1>
     <p>This page is a placeholder.</p>
     <h2>Current documentation</h2>
     <ul>
-        <li>// TODO</li>
+        <li><a href="nmdc-runtime-documentation/index.html">nmdc-runtime-documentation</a></li>
     </ul>
     <h2>Legacy documentation</h2>
     <ul>