Build docs workflow#1106
Open
ladvoc wants to merge 5 commits into
Open
Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
ladvoc
added
the
internal
alan-george-lk
approved these changes
May 20, 2026
| env: | ||
| RUSTDOCFLAGS: "-D warnings" # Fail on warnings | ||
| run: cargo doc --no-deps --workspace | ||
| - name: Upload |
Contributor
There was a problem hiding this comment.
where does it upload the doc to ?
I wonder if you should upload it to S3 so that docs.livekit.io can reference the docs there ?
Contributor
Author
There was a problem hiding this comment.
All crates published to crates.io automatically get their docs built and published to docs.rs, so you wouldn't typically self-host. I upload as an artifact here because it's sometimes useful to see the built docs for a specific branch.
Contributor
There was a problem hiding this comment.
Got it, thanks for clarification
xianshijing-lk
approved these changes
May 20, 2026
| paths: ["**/*.rs"] | ||
| push: | ||
| branches: [main] | ||
| paths: ["**/*.rs"] |
Contributor
There was a problem hiding this comment.
nit, does cargo doc get broken due to cargo config changes ? should we consider things like
paths:
- "**/*.rs"
- "**/Cargo.toml"
- "Cargo.lock"
| env: | ||
| RUSTDOCFLAGS: "-D warnings" # Fail on warnings | ||
| run: cargo doc --no-deps --workspace | ||
| - name: Upload |
Contributor
There was a problem hiding this comment.
Got it, thanks for clarification
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Validates docs build without any warnings (e.g., invalid links).