Skip to content

Commit 2df6eda

Browse files
committed
feat(docs): workflow to generate+publish API docs, call same on publish
1 parent 0bcee7b commit 2df6eda

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

.github/workflows/publish.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,3 +64,15 @@ jobs:
6464
# org admin Github Token required for the changelog/tag commit+push
6565
# to work via an exception to branch protection rules
6666
GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
67+
68+
deploy-api-reference:
69+
name: 'Deploy API Reference'
70+
needs: publish_npm
71+
uses: ./.github/workflows/deploy-api-reference.yml
72+
with:
73+
# No inputs needed as the workflow doesn't take parameters
74+
# The workflow will run with its default configuration
75+
permissions:
76+
contents: read
77+
pages: write
78+
id-token: write

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -539,6 +539,7 @@ packages/**/version.js
539539
packages/**/version.ts
540540
typedoc.raw.json
541541
reference/
542+
apidocs-out/
542543
tests/ios/Firebase
543544
tests/ios/resetXcode.sh
544545
.tmp

0 commit comments

Comments
 (0)