add multiple packages docs

decentralized-identity · Dec 15, 2023 · 094eed9 · 094eed9
1 parent dad5114
commit 094eed9
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 19 deletions.
diff --git a/.github/workflows/docs-ci.yml b/.github/workflows/docs-ci.yml
@@ -38,10 +38,17 @@ jobs:
           token: ${{ secrets.GITHUB_TOKEN }}
           report_changed_scope_only: false
           fail_on_error: false
+          group_docs: true
           entry_points: |
             - file: packages/api/src/index.ts
               docsReporter: api-extractor
               docsGenerator: typedoc-html
+            - file: packages/crypto/src/index.ts
+              docsReporter: api-extractor
+              docsGenerator: typedoc-html
+            - file: packages/dids/src/index.ts
+              docsReporter: api-extractor
+              docsGenerator: typedoc-html
 
       - name: Save Artifacts
         uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 #v3.1.3

diff --git a/.github/workflows/docs-publish.yml b/.github/workflows/docs-publish.yml
@@ -2,11 +2,10 @@
 name: Build and Deploy Docs
 
 on:
-  # TODO: uncomment before merging
   # Runs on new released versions
-  # release:
-  #   types:
-  #     - published
+  release:
+    types:
+      - published
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -51,12 +50,18 @@ jobs:
             - file: packages/api/src/index.ts
               docsReporter: api-extractor
               docsGenerator: typedoc-html
+            - file: packages/crypto/src/index.ts
+              docsReporter: api-extractor
+              docsGenerator: typedoc-html
+            - file: packages/dids/src/index.ts
+              docsReporter: api-extractor
+              docsGenerator: typedoc-html
 
       - name: Upload documentation artifacts
         uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 #v3.1.3
         with:
-          name: web5-api-docs
-          path: ./packages/api/.tbdocs/docs
+          name: tbdocs-output
+          path: ./.tbdocs
 
   deploy:
     # Add a dependency to the build job
@@ -82,18 +87,17 @@ jobs:
       - name: Setup Pages
         uses: actions/configure-pages@v3
 
-      - name: Download JSDoc artifacts
+      - name: Download TBDocs Artifacts
         uses: actions/download-artifact@v3
         with:
-          name: web5-api-docs
-          path: ./web5-api-docs
-
-      # TODO: uncomment and adjust path before merging
-      # - name: Upload artifact
-      #   uses: actions/upload-pages-artifact@v1
-      #   with:
-      #     path: "./docs"
-
-      # - name: Deploy to GitHub Pages
-      #   id: deployment
-      #   uses: actions/deploy-pages@v2
+          name: tbdocs-output
+          path: ./tbdocs
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: "./.tbdocs/docs"
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2