Skip to content

ci: add manual workflow to bump livekit-ffi - #946

Open
cloudwebrtc wants to merge 3 commits into
mainfrom
ci/bump-ffi-workflow
Open

cloudwebrtc wants to merge 3 commits into
mainfrom
ci/bump-ffi-workflow

Conversation

@cloudwebrtc

Copy link
Copy Markdown
Contributor

Adds a workflow_dispatch workflow (Bump livekit-ffi) that automates the livekit-ffi bump PRs we've been doing by hand (e.g. #891, #822).

What it does:

  1. Resolves the target version: the highest non-draft, non-prerelease livekit-ffi/vX.Y.Z release in livekit/rust-sdks, or the version input if given.
  2. Compares it with the current version in livekit-rtc/rust-sdks/livekit-ffi/Cargo.toml and exits if there is nothing newer, or if a PR for bump/livekit-ffi-vX is already open.
  3. Moves the livekit-rtc/rust-sdks submodule to the tag and checks that Cargo.toml matches.
  4. Regenerates livekit-rtc/livekit/rtc/_proto with the same protoc / mypy-protobuf versions as build-rtc.yml, and warns about .proto files that generate_proto.sh does not list.
  5. Adds a livekit-rtc changeset (bump input, default patch).
  6. Opens a Bump to livekit-ffi/vX PR with release / compare links, the file stat and the release notes.

Notes:

  • The PR is opened with GITHUB_TOKEN, so pull_request workflows do not start on their own; close and reopen the PR to run CI.
  • Python-side API changes needed by a new FFI version still have to be added by hand on the generated PR.

@github-actions

Copy link
Copy Markdown
Contributor

👋 This PR has no changeset. If it should be released, add a markdown file under .changeset/ (any name, e.g. .changeset/fix-token-parsing.md):

---
"livekit-rtc": patch
---

Short description of the change, used in the release notes.
  • Packages: livekit-rtc, livekit-api, livekit-protocol (one line per package)
  • Types: patch, minor, major, patch-rc, minor-rc, major-rc, next-rc, promote

If this change doesn't need a release (docs, CI, tests), you can ignore this comment.

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Devin Review found 1 potential issue.

1 flag not posted on this PR by your GitHub settings — view it in Devin Review. (Configure)

Devin Review

Comment on lines +20 to +22
- patch
- minor
- major

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Invalid changesets for non-main bump PRs

On a non-main dispatch, bump always produces a changeset that fails validation. Changeset validation requires RC bumps for these PRs, but every available choice requests a stable release.

Learn more

The workflow checks out the dispatch ref and uses github.ref_name as the PR base. GitHub permits dispatching workflows on non-main branches. All available bump types are stable releases, which changeset validation rejects for a non-main base using the RC-only check.

Example: A maintainer dispatches the workflow on a feature branch containing this workflow and selects a newer FFI version with patch. The workflow opens a PR against that feature branch. When CI runs, changeset validation rejects the generated stable bump.

Recommended fix: Reject non-main dispatches before generating changes, or offer RC bump types and validate the selection against the target branch before creating the PR.

Devin Review


Was this helpful? React with 👍 or 👎 to provide feedback.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants