Skip to content

Release with verwalter instead of changesets/action - #784

Open
lukasIO wants to merge 1 commit into
mainfrom
claude/migrate-release-verwalter-a70793
Open

lukasIO wants to merge 1 commit into
mainfrom
claude/migrate-release-verwalter-a70793

Conversation

@lukasIO

@lukasIO lukasIO commented Nov 16, 2026 •

Copy link
Copy Markdown
Contributor

Releases run through changesets/action in the build_and_release job of ci.yml. That job runs on every push to main, and it both commits to the release PR and publishes. This PR moves the release to verwalter. Verwalter keeps one release PR that it regenerates from main, and it tags before it publishes. Tag names, versions and changelogs continue without a gap.

Change

  • verwalter.toml lists packages/* (livekit-server-sdk, @livekit/rtc-node), the version in package.json, the existing tag format {package}@{version}, and npm as the registry. Private examples are left out.
  • Four new workflows from verwalter v0.30.0, pinned by commit:
    • release-pr.yml keeps the release PR open on each push to main.
    • release.yml tags and creates the GitHub releases after the release PR merges. Then it builds both packages and runs pnpm publish per package with npm trusted publishing. The server SDK docs build and S3 upload move to the end of this job.
    • pre-release.yml opens an rc PR on demand.
    • changeset-check.yml fails a PR that changes a package without a changeset. The internal label skips the check.
  • Removed: the build_and_release job from ci.yml, .changeset/config.json, the ci:publish script, and @changesets/cli with @livekit/changesets-changelog-github from both package.json files. ci.yml now needs only contents: read.
  • Kept: .changeset/*.md files use the same format, so pending changesets carry over. Every CHANGELOG.md stays, and new entries go on top.

Different afterwards

  • Nobody pushes to the release PR. A fix goes to main with its own changeset.
  • A failed publish leaves the tag. Re-run the Release workflow. It skips versions that npm already has.
  • Snapshot releases have no equivalent. The old setup had none either.

Verified

  • verwalter plan: 2 packages, 0 pending changesets.
  • verwalter status: both packages at the version of their last tag, with the GitHub release published and the version on npm.
  • verwalter pr --dry-run: nothing to release.
  • pnpm install --frozen-lockfile passes with the updated lock file.
  • pinact run --check passes on the new workflows.

For maintainers

The PR cannot do these:

  • Allow GitHub Actions to create pull requests (Settings, Actions, General), or add the VERWALTER_RELEASE_CLIENT_ID and VERWALTER_RELEASE_APP_KEY secrets for the verwalter GitHub App. With github.token, the release PR does not trigger CI. release.yml expects the author verwalter-release[bot]. Without the App, change that check to github-actions[bot].
  • Create the internal label, and add it to this PR. The PR changes only devDependencies of a package.
  • Make sure that npm trusted publishing for both packages names release.yml, not ci.yml.

Not done yet

  • The API check ([check].api with break-check). That is a follow-up.

🤖 Generated with Claude Code

Add verwalter.toml and the four verwalter workflows (release PR,
release, pre-release, changeset check). Remove the changesets/action
job from CI, .changeset/config.json, the ci:publish script and the
changesets devDependencies. Pending .changeset/*.md files carry over.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@lukasIO lukasIO self-assigned this Nov 16, 2026
@changeset-bot

changeset-bot Bot commented Nov 16, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 10c37f8

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@lukasIO
lukasIO marked this pull request as ready for review November 16, 2026 10:49

@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 3 potential issues.

Devin Review

on:
pull_request:
types: [closed]
branches: [main]

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.

🔴 Non-main pre-releases never publish

When pre-release targets another branch, merging its rc PR never triggers Release. The workflow only listens for PRs targeting main, so the rc version remains untagged and unpublished.

Learn more

A pre-release request opens an rc pull request against its selected target branch. pre-release passes the branch name to verwalter, which uses it as the PR base. Release only runs after a PR closes against main. For any other target, the merge creates the rc version in that branch but never tags it or publishes it.

Example: Run Pre-release PR on release-candidate. Its rc PR targets release-candidate; merging it updates the package version there, but no Release workflow starts.

Recommended fix: Allow the release workflow to handle merged verwalter rc PRs against supported target branches, while retaining the bot and marker gates. Verify checkout and publish use the merged target commit.

Devin Review


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

"jose": "^5.1.2"
},
"devDependencies": {
"@changesets/cli": "^3.0.0",

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.

🟡 Package changeset scripts lose their executable

After @changesets/cli is removed, the server SDK's changeset and ci:publish scripts still invoke changeset. Both scripts fail after a fresh install instead of creating or publishing changesets.

Learn more

The server SDK retains two scripts that call the changeset executable: changeset and ci:publish. This deletion removes the package's direct CLI dependency, and the root manifest also drops it. Fresh installs therefore supply no changeset executable for those scripts.

Example: After pnpm install, pnpm --filter livekit-server-sdk changeset invokes the retained script and exits because changeset is missing.

Recommended fix: Replace or remove both obsolete scripts as part of the migration. Point the changeset-creation script to a supported verwalter command if maintainers still need it.

Devin Review


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

continue-on-error: true
run: pnpm --filter=livekit-server-sdk build-docs
- name: S3 Upload Server SDK Docs
continue-on-error: true

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.

🟡 Failed documentation uploads pass the release

When build-docs or the S3 upload fails, continue-on-error lets the release job pass. Operators see a successful release although the server SDK documentation remains outdated.

Learn more

The release publishes server SDK documentation after npm publishing. Both documentation steps now tolerate failure, unlike the previous release workflow. If the upload fails, GitHub reports the publish job successful despite the docs site remaining unchanged. If the build fails, the upload still runs with no fresh documentation.

Example: S3 rejects an upload due to expired AWS credentials. The step reports an error, but the workflow finishes successfully while the docs site stays on the previous SDK version.

Recommended fix: Remove continue-on-error from the documentation steps, or move documentation into a separately tracked job with explicit failure reporting. Run upload only when docs build succeeds.

Devin Review


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

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant