Add credentials to published api reference docs (#417)

decentralized-identity · Feb 21, 2024 · f831621 · f831621
1 parent 80c59fd
commit f831621
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 6 deletions.
diff --git a/.github/workflows/docs-ci.yml b/.github/workflows/docs-ci.yml
@@ -56,6 +56,10 @@ jobs:
               docsReporter: typedoc
               docsGenerator: typedoc-html
               readmeFile: packages/dids/README.md
+            - file: packages/credentials/src/index.ts
+              docsReporter: typedoc
+              docsGenerator: typedoc-html
+              readmeFile: packages/credentials/README.md
 
       - 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,14 +2,15 @@
 name: Build and Deploy Docs
 
 on:
-  # Runs on pushes targeting the default branch
-  # push:
-  #   branches:
-  #     - main
-
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 
+  # Automatically triggers when a new release is published
+  workflow_run:
+    workflows: ["Release to NPM Registry"]
+    types:
+      - completed
+
 # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
 # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
 concurrency:
@@ -32,7 +33,7 @@ jobs:
         with:
           node-version: 18
           registry-url: https://registry.npmjs.org/
-          cache: 'npm'
+          cache: "npm"
 
       - name: Install dependencies
         run: |
@@ -65,6 +66,10 @@ jobs:
               docsReporter: typedoc
               docsGenerator: typedoc-html
               readmeFile: packages/dids/README.md
+            - file: packages/credentials/src/index.ts
+              docsReporter: typedoc
+              docsGenerator: typedoc-html
+              readmeFile: packages/credentials/README.md
 
       - name: Upload documentation artifacts
         uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 #v3.1.3

diff --git a/scripts/tbdocs-check-local.sh b/scripts/tbdocs-check-local.sh
@@ -24,6 +24,10 @@ INPUT_ENTRY_POINTS="
   docsReporter: typedoc
   docsGenerator: typedoc-html
   readmeFile: packages/dids/README.md
+- file: packages/credentials/src/index.ts
+  docsReporter: typedoc
+  docsGenerator: typedoc-html
+  readmeFile: packages/credentials/README.md
 "
 
 # Default docker image