Skip to content

Commit 34978fc

Browse files
stephen-derosadevin-ai-integration[bot]
stephen-derosa
and
devin-ai-integration[bot]
committed
tool: update-rust-sdk.sh script, update rust hash
tool: update-cpp-example-collection.sh Co-authored-by: devin-ai-integration[bot] <158243242+devin-ai-integration[bot]@users.noreply.github.com>
1 parent 5cd2af1 commit 34978fc

3 files changed

Lines changed: 357 additions & 10 deletions

File tree

‎docs/tools.md‎

Lines changed: 35 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -163,23 +163,48 @@ For details on the Doxygen configuration and CI pipeline, see the
163163

164164
### Bump the pinned Rust submodule
165165

166+
Update to the commit from the most recent published Rust SDK release:
167+
166168
```bash
167-
cd client-sdk-cpp
168-
git fetch origin
169-
git switch -c try-rust-main origin/main
169+
./scripts/update-rust-sdk.sh
170+
```
171+
172+
The script requires the GitHub CLI (`gh`) when `--hash` is omitted. To select a
173+
specific commit without `gh`, pass its full or abbreviated hash:
170174

171-
# Sync submodule URLs and check out what origin/main pins (recursively):
172-
git submodule sync --recursive
173-
git submodule update --init --recursive --checkout
175+
```bash
176+
./scripts/update-rust-sdk.sh --hash 1a477bc
177+
```
174178

175-
# If the nested submodule under yuv-sys didn't materialize, force it:
176-
git -C client-sdk-rust/yuv-sys submodule sync --recursive
177-
git -C client-sdk-rust/yuv-sys submodule update --init --recursive --checkout
179+
The script updates the `client-sdk-rust` gitlink and synchronizes its nested
180+
submodules. It stops without changing the checkout if the Rust submodule has
181+
tracked changes.
178182

179-
# Sanity check:
183+
Review the selected commits before committing the gitlink update:
184+
185+
```bash
180186
git submodule status --recursive
181187
```
182188

189+
### Bump the pinned C++ example collection
190+
191+
Update to the most recent commit on the `main` branch of the examples
192+
repository:
193+
194+
```bash
195+
./scripts/update-cpp-example-collection.sh
196+
```
197+
198+
To select a specific commit, pass its full or abbreviated hash:
199+
200+
```bash
201+
./scripts/update-cpp-example-collection.sh --hash 7e76bea
202+
```
203+
204+
The script updates the `cpp-example-collection` gitlink and synchronizes its
205+
nested submodules. It stops without changing the checkout if the examples
206+
submodule has tracked changes.
207+
183208
### If `yuv-sys` fails to build
184209

185210
```bash

‎scripts/update-cpp-example-collection.sh‎

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
#!/usr/bin/env bash
2+
#
3+
# Copyright 2026 LiveKit
4+
#
5+
# Licensed under the Apache License, Version 2.0 (the "License");
6+
# you may not use this file except in compliance with the License.
7+
# You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing, software
12+
# distributed under the License is distributed on an "AS IS" BASIS,
13+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
# See the License for the specific language governing permissions and
15+
# limitations under the License.
16+
17+
set -euo pipefail
18+
19+
script_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd -P)"
20+
repo_root="$(cd "${script_dir}/.." && pwd -P)"
21+
examples_dir="${repo_root}/cpp-example-collection"
22+
examples_repo="livekit-examples/cpp-example-collection"
23+
examples_remote="https://github.com/${examples_repo}.git"
24+
default_branch="main"
25+
26+
usage() {
27+
cat <<'EOF'
28+
Usage: ./scripts/update-cpp-example-collection.sh [--hash HASH]
29+
30+
Update the cpp-example-collection submodule used by the C++ SDK.
31+
32+
Options:
33+
--hash HASH
34+
Use the specified examples commit. You can use a short or full SHA-1
35+
hash.
36+
-h, --help
37+
Show this help and exit.
38+
39+
When --hash is omitted, the script uses the most recent commit on the main
40+
branch of livekit-examples/cpp-example-collection.
41+
EOF
42+
}
43+
44+
requested_hash=""
45+
hash_provided=false
46+
47+
while (($#)); do
48+
case "$1" in
49+
--hash)
50+
shift
51+
if (($# == 0)); then
52+
echo "ERROR: --hash requires a value" >&2
53+
exit 2
54+
fi
55+
requested_hash="$1"
56+
hash_provided=true
57+
shift
58+
;;
59+
--hash=*)
60+
requested_hash="${1#--hash=}"
61+
hash_provided=true
62+
shift
63+
;;
64+
-h|--help)
65+
usage
66+
exit 0
67+
;;
68+
*)
69+
echo "ERROR: unknown argument: $1" >&2
70+
usage >&2
71+
exit 2
72+
;;
73+
esac
74+
done
75+
76+
if [[ "$hash_provided" == true && ! "$requested_hash" =~ ^[0-9a-fA-F]{7,40}$ ]]; then
77+
echo "ERROR: --hash must be a 7- to 40-character hexadecimal Git SHA-1 hash" >&2
78+
exit 2
79+
fi
80+
81+
if ! command -v git >/dev/null 2>&1; then
82+
echo "ERROR: git not found in PATH" >&2
83+
exit 1
84+
fi
85+
86+
if ! git -C "$repo_root" rev-parse --show-toplevel >/dev/null 2>&1; then
87+
echo "ERROR: ${repo_root} is not a Git worktree" >&2
88+
exit 1
89+
fi
90+
91+
if [[ ! -e "${examples_dir}/.git" ]]; then
92+
echo "==> Initializing cpp-example-collection"
93+
git -C "$repo_root" submodule update --init cpp-example-collection
94+
fi
95+
96+
if ! git -C "$examples_dir" diff --quiet ||
97+
! git -C "$examples_dir" diff --cached --quiet; then
98+
echo "ERROR: cpp-example-collection has tracked changes; commit or stash them first" >&2
99+
exit 1
100+
fi
101+
102+
fetch_ref="$requested_hash"
103+
104+
if [[ "$hash_provided" == false ]]; then
105+
echo "==> Finding the most recent cpp-example-collection commit"
106+
branch_ref="refs/heads/${default_branch}"
107+
remote_ref="$(git ls-remote "$examples_remote" "$branch_ref")"
108+
read -r requested_hash resolved_ref <<<"$remote_ref"
109+
if [[ -z "$requested_hash" || "$resolved_ref" != "$branch_ref" ]]; then
110+
echo "ERROR: branch '${default_branch}' was not found in ${examples_repo}" >&2
111+
exit 1
112+
fi
113+
fetch_ref="$branch_ref"
114+
echo "==> Latest ${default_branch} commit: ${requested_hash}"
115+
else
116+
requested_hash="$(printf '%s' "$requested_hash" | tr '[:upper:]' '[:lower:]')"
117+
echo "==> Requested examples commit: ${requested_hash}"
118+
fi
119+
120+
echo "==> Fetching cpp-example-collection"
121+
if [[ "$hash_provided" == false ]]; then
122+
git -C "$examples_dir" fetch --quiet origin "$fetch_ref"
123+
elif [[ ${#requested_hash} -eq 40 ]]; then
124+
if ! git -C "$examples_dir" fetch --quiet origin "$fetch_ref"; then
125+
git -C "$examples_dir" fetch --quiet origin
126+
fi
127+
else
128+
git -C "$examples_dir" fetch --quiet origin
129+
fi
130+
131+
if ! resolved_hash="$(git -C "$examples_dir" rev-parse --verify "${requested_hash}^{commit}" 2>/dev/null)"; then
132+
echo "ERROR: '${requested_hash}' does not resolve to a cpp-example-collection commit" >&2
133+
exit 1
134+
fi
135+
136+
current_hash="$(git -C "$examples_dir" rev-parse HEAD)"
137+
if [[ "$current_hash" == "$resolved_hash" ]]; then
138+
echo "==> cpp-example-collection is already at ${resolved_hash}"
139+
else
140+
git -C "$examples_dir" checkout --quiet --detach "$resolved_hash"
141+
echo "==> Updated cpp-example-collection: ${current_hash} -> ${resolved_hash}"
142+
fi
143+
144+
echo "==> Synchronizing nested example submodules"
145+
git -C "$examples_dir" submodule sync --recursive
146+
git -C "$examples_dir" submodule update --init --recursive
147+
148+
echo "==> Done. Review and commit the cpp-example-collection gitlink change."

‎scripts/update-rust-sdk.sh‎

Lines changed: 174 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
1+
#!/usr/bin/env bash
2+
#
3+
# Copyright 2026 LiveKit
4+
#
5+
# Licensed under the Apache License, Version 2.0 (the "License");
6+
# you may not use this file except in compliance with the License.
7+
# You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing, software
12+
# distributed under the License is distributed on an "AS IS" BASIS,
13+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
# See the License for the specific language governing permissions and
15+
# limitations under the License.
16+
17+
set -euo pipefail
18+
19+
script_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd -P)"
20+
repo_root="$(cd "${script_dir}/.." && pwd -P)"
21+
rust_dir="${repo_root}/client-sdk-rust"
22+
rust_repo="livekit/client-sdk-rust"
23+
rust_remote="https://github.com/${rust_repo}.git"
24+
25+
usage() {
26+
cat <<'EOF'
27+
Usage: ./scripts/update-rust-sdk.sh [--hash HASH]
28+
29+
Update the client-sdk-rust submodule used by the C++ SDK.
30+
31+
Options:
32+
--hash HASH
33+
Use the specified Rust SDK commit. You can use a short or full SHA-1
34+
hash.
35+
-h, --help
36+
Show this help and exit.
37+
38+
When --hash is omitted, the script uses the commit tagged by the most recent
39+
published, non-draft GitHub release in livekit/client-sdk-rust (requires gh).
40+
EOF
41+
}
42+
43+
requested_hash=""
44+
hash_provided=false
45+
46+
while (($#)); do
47+
case "$1" in
48+
--hash)
49+
shift
50+
if (($# == 0)); then
51+
echo "ERROR: --hash requires a value" >&2
52+
exit 2
53+
fi
54+
requested_hash="$1"
55+
hash_provided=true
56+
shift
57+
;;
58+
--hash=*)
59+
requested_hash="${1#--hash=}"
60+
hash_provided=true
61+
shift
62+
;;
63+
-h|--help)
64+
usage
65+
exit 0
66+
;;
67+
*)
68+
echo "ERROR: unknown argument: $1" >&2
69+
usage >&2
70+
exit 2
71+
;;
72+
esac
73+
done
74+
75+
if [[ "$hash_provided" == true && ! "$requested_hash" =~ ^[0-9a-fA-F]{7,40}$ ]]; then
76+
echo "ERROR: --hash must be a 7- to 40-character hexadecimal Git SHA-1 hash" >&2
77+
exit 2
78+
fi
79+
80+
if ! command -v git >/dev/null 2>&1; then
81+
echo "ERROR: git not found in PATH" >&2
82+
exit 1
83+
fi
84+
85+
if ! git -C "$repo_root" rev-parse --show-toplevel >/dev/null 2>&1; then
86+
echo "ERROR: ${repo_root} is not a Git worktree" >&2
87+
exit 1
88+
fi
89+
90+
if [[ ! -e "${rust_dir}/.git" ]]; then
91+
echo "==> Initializing client-sdk-rust"
92+
git -C "$repo_root" submodule update --init client-sdk-rust
93+
fi
94+
95+
if ! git -C "$rust_dir" diff --quiet ||
96+
! git -C "$rust_dir" diff --cached --quiet; then
97+
echo "ERROR: client-sdk-rust has tracked changes; commit or stash them first" >&2
98+
exit 1
99+
fi
100+
101+
fetch_ref="$requested_hash"
102+
release_tag=""
103+
104+
if [[ "$hash_provided" == false ]]; then
105+
if ! command -v gh >/dev/null 2>&1; then
106+
echo "ERROR: gh not found in PATH; install GitHub CLI or provide --hash" >&2
107+
exit 1
108+
fi
109+
110+
echo "==> Finding the most recent published Rust SDK release"
111+
release_tags="$(
112+
gh api --paginate "repos/${rust_repo}/releases?per_page=100" \
113+
--jq '.[] | select(.draft == false) | .tag_name'
114+
)"
115+
release_tag="${release_tags%%$'\n'*}"
116+
if [[ -z "$release_tag" ]]; then
117+
echo "ERROR: no published release found for ${rust_repo}" >&2
118+
exit 1
119+
fi
120+
121+
tag_refs="$(
122+
git ls-remote "$rust_remote" \
123+
"refs/tags/${release_tag}" "refs/tags/${release_tag}^{}"
124+
)"
125+
while read -r tag_hash tag_ref; do
126+
if [[ "$tag_ref" == "refs/tags/${release_tag}^{}" ]]; then
127+
requested_hash="$tag_hash"
128+
break
129+
fi
130+
if [[ "$tag_ref" == "refs/tags/${release_tag}" ]]; then
131+
requested_hash="$tag_hash"
132+
fi
133+
done <<<"$tag_refs"
134+
135+
if [[ -z "$requested_hash" ]]; then
136+
echo "ERROR: release tag '${release_tag}' was not found in ${rust_repo}" >&2
137+
exit 1
138+
fi
139+
fetch_ref="refs/tags/${release_tag}"
140+
echo "==> Latest release: ${release_tag} (${requested_hash})"
141+
else
142+
requested_hash="$(printf '%s' "$requested_hash" | tr '[:upper:]' '[:lower:]')"
143+
echo "==> Requested Rust SDK commit: ${requested_hash}"
144+
fi
145+
146+
echo "==> Fetching client-sdk-rust"
147+
if [[ "$hash_provided" == false ]]; then
148+
git -C "$rust_dir" fetch --quiet origin "$fetch_ref"
149+
elif [[ ${#requested_hash} -eq 40 ]]; then
150+
if ! git -C "$rust_dir" fetch --quiet origin "$fetch_ref"; then
151+
git -C "$rust_dir" fetch --quiet origin
152+
fi
153+
else
154+
git -C "$rust_dir" fetch --quiet origin
155+
fi
156+
157+
if ! resolved_hash="$(git -C "$rust_dir" rev-parse --verify "${requested_hash}^{commit}" 2>/dev/null)"; then
158+
echo "ERROR: '${requested_hash}' does not resolve to a client-sdk-rust commit" >&2
159+
exit 1
160+
fi
161+
162+
current_hash="$(git -C "$rust_dir" rev-parse HEAD)"
163+
if [[ "$current_hash" == "$resolved_hash" ]]; then
164+
echo "==> client-sdk-rust is already at ${resolved_hash}"
165+
else
166+
git -C "$rust_dir" checkout --quiet --detach "$resolved_hash"
167+
echo "==> Updated client-sdk-rust: ${current_hash} -> ${resolved_hash}"
168+
fi
169+
170+
echo "==> Synchronizing nested Rust SDK submodules"
171+
git -C "$rust_dir" submodule sync --recursive
172+
git -C "$rust_dir" submodule update --init --recursive --checkout
173+
174+
echo "==> Done. Review and commit the client-sdk-rust gitlink change."

0 commit comments

Comments
 (0)