Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add credentials to published api reference docs #417

Merged
merged 1 commit into from
Feb 21, 2024
Merged

Add credentials to published api reference docs #417

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/workflows/docs-ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
17 changes: 11 additions & 6 deletions .github/workflows/docs-publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -32,7 +33,7 @@ jobs:
with:
node-version: 18
registry-url: https://registry.npmjs.org/
cache: 'npm'
cache: "npm"

- name: Install dependencies
run: |
Expand Down Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions scripts/tbdocs-check-local.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading