Repository navigation
chore: release packages with verwalter instead of changesets/action - #784
Conversation
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>
|
Run the release workflow for verwalter PRs on any base branch, so an rc PR from another branch is tagged and published. Remove the server SDK's changeset and ci:publish scripts. Let a failed docs build or upload fail the publish job. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
An rc release must not replace the docs of the current stable release. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
| command: publish | ||
| releases: ${{ needs.release.outputs.releases }} | ||
|
|
||
| # The docs site holds one version: an rc must not replace it. |
There was a problem hiding this comment.
nitpick: an rc?
| # The docs site holds one version: an rc must not replace it. | |
| # The docs site holds one version: a rc must not replace it. |
There was a problem hiding this comment.
I kept "an rc". "rc" is said "ar-see", which starts with a vowel sound, so it takes "an".
xianshijing-lk
left a comment
There was a problem hiding this comment.
Reviewed the release workflows and validated the source/tag mismatch and docs guard with local fixtures against the pinned verwalter v0.30.0. Two correctness findings and one non-blocking concurrency suggestion are inline. No packages or documentation were published during validation.
| steps: | ||
| - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | ||
| with: | ||
| ref: ${{ github.event.pull_request.merge_commit_sha || github.sha }} |
There was a problem hiding this comment.
[P1] Reject source/tag mismatches during manual recovery
A fresh manual dispatch on main checks out the branch's current SHA. If a failed publish left a release tag at commit A and the branch has advanced to B without another version bump, recovery can publish B's source under A's already-tagged version.
I validated this with the pinned verwalter v0.30.0: with the tag pointing to A and the same package version at B, both release --dry-run --package livekit-server-sdk and publish --dry-run accept the mismatch. The build steps here compile B before publishing.
Please reject a mismatch between the package's release tag and the checkout before building/publishing. Documenting recovery by re-running the original workflow or dispatching its original tag would also help operators choose the right source.
There was a problem hiding this comment.
Fixed in 59ed548.
- A run by hand takes a
refinput. All checkouts usemerge_commit_sha || inputs.ref || github.sha. - Before the build, the publish job fails if a package that this run publishes differs from its release tag. The check uses
git diff --quiet <tag> HEAD -- <package dir>. The error message namesref=<tag>. - The check covers only packages in
releases(or all, if the list is empty) that have a tag and are not on npm yet. Without that limit, a package that changed after its last release through aninternalPR would block every later release. - The comment on
workflow_dispatchnow says to use "Re-run failed jobs" first, and to run by hand only withrefset to the tag.
I tested the check with fixtures: it fails on a newer commit and passes at the tag. verwalter itself checks only that the tag exists, so I will also report this upstream.
There was a problem hiding this comment.
Update: I removed the guard step again in 10da6cd. The next verwalter release fixes this in publish itself (livekit/verwalter#105): it fails a package whose files changed since its tag, and the reason names ref=<tag>. I will bump the pin when that release is out. Until then, a run by hand must set ref to the release tag, as the comment in release.yml says.
There was a problem hiding this comment.
Done in 8d3b36b: the workflows now pin verwalter v0.31.0, whose publish fails a package whose files changed since its tag (livekit/verwalter#105).
| id: docs | ||
| run: | | ||
| version=$(node -p "require('./packages/livekit-server-sdk/package.json').version") | ||
| if [[ "$version" != *-* ]]; then echo "stable=true" >> "$GITHUB_OUTPUT"; fi |
There was a problem hiding this comment.
[P2] Restrict stable documentation deployment to the appropriate server SDK release
A stable version in this checkout does not establish that this run released the server SDK or that this branch contains the current stable documentation. An RTC-only prerelease on a maintenance branch can leave the server SDK at an older stable version and overwrite the single unversioned documentation destination.
I ran this guard against the server SDK manifest from the real livekit-server-sdk@2.19.3 tag: it emits stable=true even with an RTC-only release handoff. Both documentation steps then run.
Please require an appropriate stable server SDK release in needs.release.outputs.releases and restrict this unversioned destination to the designated current release line. Other branches can skip deployment or use a versioned prefix; keep a way to retry a failed docs deployment.
There was a problem hiding this comment.
Fixed in 59ed548. The docs job now runs only when releases contains livekit-server-sdk with prerelease == false, and only for main (the base branch of the PR, or the branch of a run by hand). A release of rtc-node alone, an rc, or another branch skips it. To retry a failed docs upload, start a run by hand with package=livekit-server-sdk, which reports the package again.
xianshijing-lk
left a comment
There was a problem hiding this comment.
got some review comments from ai, maybe take a look ?
A docs failure no longer turns the publish job red after npm has the version. A publish job waits for a running one instead of publishing the same version twice. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- Add a ref input for runs by hand. Before the build, fail when a package to publish differs from its release tag. - Upload the server SDK docs only when this run released a final server SDK version from main. - Keep every waiting publish run with queue: max. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The next verwalter release checks in publish that each package matches its tag (livekit/verwalter#105). Until then, a run by hand sets ref to the tag. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
v0.31.0 checks in publish that each package matches its tag, so the note about v0.30.0 goes. A verify job runs status --check after the publish, as in the upstream example. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
A build job runs first and uploads the build output. A build that fails now stops the run before release creates any tag. publish and docs use that output instead of building after the tag. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…e-verwalter-a70793 # Conflicts: # pnpm-lock.yaml
Releases run through
changesets/actionin thebuild_and_releasejob ofci.yml. That job runs on every push tomain, 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 frommain, and it tags before it publishes. Tag names, versions and changelogs continue without a gap.Change
verwalter.tomllistspackages/*(livekit-server-sdk,@livekit/rtc-node), the version inpackage.json, the existing tag format{package}@{version}, and npm as the registry. Private examples are left out.release-pr.ymlkeeps the release PR open on each push tomain.release.ymlruns after a release PR merges, on any base branch, so that an rc PR from another branch is released too. It has four jobs:releasetags and creates the GitHub releases.publishbuilds both packages and runspnpm publishper package with npm trusted publishing. It skips versions that npm has, and it fails a package whose files changed since its tag. One publish runs at a time (npm-publishgroup withqueue: max).verifyrunsverwalter status --check. If a tag, a public GitHub release or an npm version is missing, it fails.docsbuilds the server SDK docs and uploads them to S3. It runs only for a finallivekit-server-sdkrelease frommain. An rc or a release of rtc-node alone does not replace the docs.pre-release.ymlopens an rc PR on demand.changeset-check.ymlfails a PR that changes a package without a changeset. Theinternallabel skips the check.build_and_releasejob fromci.yml,.changeset/config.json, theci:publishandchangesetscripts, and@changesets/cliwith@livekit/changesets-changelog-githubfrom bothpackage.jsonfiles.ci.ymlnow needs onlycontents: read..changeset/*.mdfiles use the same format, so pending changesets carry over. EveryCHANGELOG.mdstays, and new entries go on top.Different afterwards
mainwith its own changeset.refto the release tag. If no tag exists yet, set it to the merge commit of the release PR. An emptyrefmeans the head of the branch.docsjob red. To deploy the docs again, run the workflow by hand withpackage=livekit-server-sdkandref=livekit-server-sdk@<version>.Verified
planshows 2 packages and 0 pending changesets.status --checkexits 0.publish --dry-runskips both versions because npm has them.releases: it runs for a finallivekit-server-sdkrelease. It skips an rc, a release of rtc-node alone, and an empty list.pnpm install --frozen-lockfileandpinact run --checkpass. The docs job's build sequence runs locally.queueinconcurrency. GitHub addedqueuein May 2026, after that actionlint release. The workflow syntax docs allow it at job level.For maintainers
The PR cannot do these:
release.yml, notci.yml. Else the first publish fails and the release stays a draft.internallabel, and add it to this PR. The PR changes only devDependencies and scripts of a package.Not done yet
[check].apiwith break-check). That is a follow-up.🤖 Generated with Claude Code