Skip to content

Build docs workflow #1106

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

Open
ladvoc wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Build docs workflow #1106

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dd0fc33
Create docs build workflow
ladvoc May 20, 2026
0677d58
Pin actions
ladvoc May 20, 2026
3cdaa06
Set perms
ladvoc May 20, 2026
a45aacc
Fix existing docs warnings
ladvoc May 20, 2026
38232bf
Don't automatically set rustflags
ladvoc May 20, 2026
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
46 changes: 46 additions & 0 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Copyright 2026 LiveKit, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: Docs
on:
workflow_dispatch:
pull_request:
branches: [main]
paths: ["**/*.rs"]
push:
branches: [main]
paths: ["**/*.rs"]
Copy link
Copy Markdown
Contributor

@xianshijing-lk xianshijing-lk May 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit, does cargo doc get broken due to cargo config changes ? should we consider things like
paths:

  • "**/*.rs"
  • "**/Cargo.toml"
  • "Cargo.lock"

concurrency:
group: docs-${{ github.ref }}
cancel-in-progress: true
jobs:
docs:
name: Build Docs
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
- name: Setup Rust Toolchain
uses: actions-rust-lang/setup-rust-toolchain@46268bd060767258de96ed93c1251119784f2ab6 # v1.16.1
- name: Cargo Doc
env:
RUSTDOCFLAGS: "-D warnings" # Fail on warnings
run: cargo doc --no-deps
- name: Upload
Copy link
Copy Markdown
Contributor

@xianshijing-lk xianshijing-lk May 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 ?

Copy link
Copy Markdown
Contributor Author

@ladvoc ladvoc May 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

@xianshijing-lk xianshijing-lk May 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it, thanks for clarification

uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
with:
name: docs
path: target/doc
if-no-files-found: error
retention-days: 1

Check warning

Code scanning / CodeQL

Workflow does not contain permissions Medium

Actions job or workflow does not limit the permissions of the GITHUB_TOKEN. Consider setting an explicit permissions block, using the following as a minimal starting point: {contents: read}
Comment thread
github-advanced-security[bot] marked this conversation as resolved.
Fixed
Loading