-
Notifications
You must be signed in to change notification settings - Fork 91
Add docs generation workflows #527
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.
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
Open
rektdeckard
wants to merge
5
commits into
main
Choose a base branch
from
tobias/dpro-377-add-nodejs-reference-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
2adb53f
feat: set up typedoc and standardize versions
rektdeckard 7688a33
feat(ci): add docs deploy workflow
rektdeckard 1433ac2
chore(ci): reduce workflow permissions
rektdeckard bbc2ccc
chore(ci): use checkboxes to select docs deploys
rektdeckard a4e0021
chore(ci): rename s3 bucket client-sdk-node -> rtc-node
rektdeckard File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| # SPDX-FileCopyrightText: 2025 LiveKit, Inc. | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| name: Publish Docs | ||
| permissions: | ||
| contents: read | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| inputs: | ||
| livekit-rtc: | ||
| description: "Build and deploy docs for livekit-rtc" | ||
| required: false | ||
| default: true | ||
| type: boolean | ||
| livekit-server-sdk: | ||
| description: "Build and deploy docs for livekit-server-sdk" | ||
| required: false | ||
| default: true | ||
| type: boolean | ||
|
|
||
| concurrency: ${{ github.workflow }}-${{ github.ref }} | ||
|
|
||
| jobs: | ||
| build: | ||
| name: Build docs and publish to S3 | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| lfs: true | ||
| - uses: pnpm/action-setup@v4 | ||
| - name: Use Node.js 20 | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 20 | ||
| cache: pnpm | ||
| - name: Install dependencies | ||
| run: pnpm install --frozen-lockfile | ||
|
|
||
| - name: Build docs for livekit-rtc | ||
| if: ${{ github.event.inputs.livekit-rtc }} | ||
| run: | | ||
| cd packages/livekit-rtc | ||
| pnpm build:docs | ||
|
|
||
| - name: Build docs for livekit-server-sdk | ||
| if: ${{ github.event.inputs.livekit-server-sdk }} | ||
| run: | | ||
| cd packages/livekit-server-sdk | ||
| pnpm build:docs | ||
|
|
||
| - name: Upload livekit-rtc docs to S3 | ||
| if: ${{ github.event.inputs.livekit-rtc }} | ||
| run: | | ||
| aws s3 cp packages/livekit-rtc/docs/ s3://livekit-docs/rtc-node --recursive | ||
| env: | ||
| AWS_ACCESS_KEY_ID: ${{ secrets.DOCS_DEPLOY_AWS_ACCESS_KEY }} | ||
| AWS_SECRET_ACCESS_KEY: ${{ secrets.DOCS_DEPLOY_AWS_API_SECRET }} | ||
| AWS_DEFAULT_REGION: "us-east-1" | ||
|
|
||
| - name: Upload livekit-server-sdk docs to S3 | ||
| if: ${{ github.event.inputs.livekit-server-sdk }} | ||
| run: | | ||
| aws s3 cp packages/livekit-server-sdk/docs/ s3://livekit-docs/server-sdk-js --recursive | ||
| env: | ||
| AWS_ACCESS_KEY_ID: ${{ secrets.DOCS_DEPLOY_AWS_ACCESS_KEY }} | ||
| AWS_SECRET_ACCESS_KEY: ${{ secrets.DOCS_DEPLOY_AWS_API_SECRET }} | ||
| AWS_DEFAULT_REGION: "us-east-1" | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -38,7 +38,8 @@ | |
| "eslint-plugin-tsdoc": "^0.4.0", | ||
| "prettier": "^3.2.5", | ||
| "turbo": "^2.0.0", | ||
| "typescript": "5.8.2", | ||
| "typedoc": "catalog:", | ||
| "typescript": "catalog:", | ||
| "vitest": "^3.0.0" | ||
| }, | ||
| "packageManager": "[email protected]" | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this looks like triggering publishing of docs is exclusively a manual process.
It would be great if we could automate it as part of the release workflow, i.e. if a package got published, also publish the latest docs, so that the docs are always up to date with the latest release without us having to remember explicitly publishing the docs.