Repository navigation
Release with verwalter instead of changesets/action #784
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| # SPDX-FileCopyrightText: 2026 LiveKit, Inc. | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| # Fails a contributor PR that changes a versioned package without a | ||
| # changeset, with a comment that links to a prefilled changeset file. | ||
| # The `internal` label skips the check. | ||
| name: Changeset check | ||
|
|
||
| on: | ||
| pull_request: | ||
| types: [opened, synchronize, reopened, labeled, unlabeled] | ||
| branches: [main] | ||
|
|
||
| permissions: | ||
| contents: read | ||
| pull-requests: write | ||
|
|
||
| jobs: | ||
| check: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | ||
| - uses: livekit/verwalter@359985c1e5567b17ae84db0241fbb305c383f89e # v0.30.0 | ||
| with: | ||
| command: check |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| # SPDX-FileCopyrightText: 2026 LiveKit, Inc. | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| # On demand: open an rc PR from the branch the workflow is run on. The | ||
| # levels come from the changesets. Merging the PR tags 1.6.0-rc.1; the | ||
| # next run numbers rc.2. Changesets stay pending for the final release. | ||
| name: Pre-release PR | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
|
|
||
| permissions: | ||
| contents: write | ||
| pull-requests: write | ||
|
|
||
| jobs: | ||
| pr: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | ||
| with: | ||
| fetch-depth: 0 # the tags number the rc | ||
| - uses: livekit/verwalter@359985c1e5567b17ae84db0241fbb305c383f89e # v0.30.0 | ||
| with: | ||
| command: pre-release | ||
| args: --target ${{ github.ref_name }} | ||
| app-client-id: ${{ secrets.VERWALTER_RELEASE_CLIENT_ID }} | ||
| app-private-key: ${{ secrets.VERWALTER_RELEASE_APP_KEY }} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| # SPDX-FileCopyrightText: 2026 LiveKit, Inc. | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| # Keeps one release PR open while changesets are pending. Runs on every | ||
| # push to main and regenerates the release branch from main. | ||
| name: Release PRs | ||
|
|
||
| on: | ||
| push: | ||
| branches: [main] | ||
|
|
||
| permissions: | ||
| contents: write | ||
| pull-requests: write | ||
|
|
||
| concurrency: | ||
| group: release-prs | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| pr: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | ||
| with: | ||
| fetch-depth: 0 # the commit that added a changeset gives its changelog line the PR and author | ||
| - uses: livekit/verwalter@359985c1e5567b17ae84db0241fbb305c383f89e # v0.30.0 | ||
| with: | ||
| command: pr | ||
| # A GitHub App token lets the release PRs trigger CI; the default | ||
| # github.token does not. Without these secrets, github.token is used. | ||
| app-client-id: ${{ secrets.VERWALTER_RELEASE_CLIENT_ID }} | ||
| app-private-key: ${{ secrets.VERWALTER_RELEASE_APP_KEY }} |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,98 @@ | ||||||
| # SPDX-FileCopyrightText: 2026 LiveKit, Inc. | ||||||
| # | ||||||
| # SPDX-License-Identifier: Apache-2.0 | ||||||
|
|
||||||
| # After a release PR merges: tag and create the GitHub releases, then | ||||||
| # publish to npm. The step that cannot be undone comes last. | ||||||
| name: Release | ||||||
|
|
||||||
| on: | ||||||
| # Any base branch: an rc PR from `pre-release` targets the branch it | ||||||
| # was run on. The bot and marker check on the job gates the run. | ||||||
| pull_request: | ||||||
| types: [closed] | ||||||
| # Re-run by hand after a fix: `verwalter release` resumes from the | ||||||
| # current state and skips what is done. With `package`, that package | ||||||
| # is reported again even when complete, so the publish job runs for it. | ||||||
| workflow_dispatch: | ||||||
| inputs: | ||||||
| package: | ||||||
| description: Only this package; always reported to the publish job. | ||||||
| required: false | ||||||
| default: '' | ||||||
|
|
||||||
| permissions: | ||||||
| contents: write | ||||||
| id-token: write # trusted publishing | ||||||
|
|
||||||
| jobs: | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Non-blocking: serialize release workflows without dropping pending releases Could we serialize the whole release workflow? An older run can fetch tags before a newer release exists, finish after it, and publish to A shared concurrency group with The previous workflow also lacked serialization, so this is optional hardening rather than a regression introduced here. |
||||||
| release: | ||||||
| # Only a release PR the tool opened: the branch prefix alone would let | ||||||
| # any pushed `release/*` branch trigger a publish. | ||||||
| if: github.event_name == 'workflow_dispatch' || (github.event.pull_request.merged == true && startsWith(github.event.pull_request.head.ref, 'release/') && github.event.pull_request.user.login == 'verwalter-release[bot]' && contains(github.event.pull_request.body, '<!-- verwalter release -->')) | ||||||
| runs-on: ubuntu-latest | ||||||
| outputs: | ||||||
| released: ${{ steps.verwalter.outputs.released }} | ||||||
| releases: ${{ steps.verwalter.outputs.releases }} | ||||||
| steps: | ||||||
| - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | ||||||
| with: | ||||||
| # The merge commit itself: a push to main right after the merge | ||||||
| # must not move the tags. | ||||||
| ref: ${{ github.event.pull_request.merge_commit_sha || github.sha }} | ||||||
| fetch-depth: 0 | ||||||
| - id: verwalter | ||||||
| uses: livekit/verwalter@359985c1e5567b17ae84db0241fbb305c383f89e # v0.30.0 | ||||||
| with: | ||||||
| command: release | ||||||
| args: ${{ inputs.package && format('--package {0}', inputs.package) || '' }} | ||||||
|
|
||||||
| publish: | ||||||
| needs: release | ||||||
| if: needs.release.outputs.released == 'true' || github.event_name == 'workflow_dispatch' | ||||||
| runs-on: ubuntu-latest | ||||||
| permissions: | ||||||
| contents: write # the tool flips draft releases after the publish | ||||||
| id-token: write # trusted publishing | ||||||
| steps: | ||||||
| - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | ||||||
| with: | ||||||
| ref: ${{ github.event.pull_request.merge_commit_sha || github.sha }} | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [P1] Reject source/tag mismatches during manual recovery A fresh manual dispatch on I validated this with the pinned verwalter v0.30.0: with the tag pointing to A and the same package version at B, both 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. |
||||||
| fetch-depth: 0 # tags decide what is published | ||||||
| - uses: pnpm/action-setup@fc06bc1257f339d1d5d8b3a19a8cae5388b55320 # v4.4.0 | ||||||
| # No registry-url: npm trusted publishing needs no token, and the | ||||||
| # placeholder token setup-node writes would make the publish fail. | ||||||
| - uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0 | ||||||
| with: | ||||||
| node-version: 24 # npm 11.5.1 or later is required for OIDC | ||||||
| cache: pnpm | ||||||
| - run: pnpm install | ||||||
| - name: Build server SDK | ||||||
| run: pnpm --filter="livekit-server-sdk" build | ||||||
| - name: Build rtc-node | ||||||
| run: pnpm --filter="@livekit/rtc-node" build | ||||||
| - uses: livekit/verwalter@359985c1e5567b17ae84db0241fbb305c383f89e # v0.30.0 | ||||||
| env: | ||||||
| GH_TOKEN: ${{ github.token }} | ||||||
| with: | ||||||
| command: publish | ||||||
| releases: ${{ needs.release.outputs.releases }} | ||||||
|
|
||||||
| # The docs site holds one version: an rc must not replace it. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nitpick:
Suggested change
|
||||||
| - name: Check for a stable server SDK version | ||||||
| id: docs | ||||||
| run: | | ||||||
| version=$(node -p "require('./packages/livekit-server-sdk/package.json').version") | ||||||
| if [[ "$version" != *-* ]]; then echo "stable=true" >> "$GITHUB_OUTPUT"; fi | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [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 Please require an appropriate stable server SDK release in |
||||||
| # A failure here fails the job. A re-run is safe: publish skips the | ||||||
| # versions that npm already has. | ||||||
| - name: Build Server SDK Docs | ||||||
| if: steps.docs.outputs.stable == 'true' | ||||||
| run: pnpm --filter=livekit-server-sdk build-docs | ||||||
| - name: S3 Upload Server SDK Docs | ||||||
| if: steps.docs.outputs.stable == 'true' | ||||||
| run: aws s3 cp packages/livekit-server-sdk/docs/ s3://livekit-docs/server-sdk-js --recursive | ||||||
| env: | ||||||
| AWS_ACCESS_KEY_ID: ${{ secrets.DOCS_DEPLOY_AWS_ACCESS_KEY }} | ||||||
| AWS_SECRET_ACCESS_KEY: ${{ secrets.DOCS_DEPLOY_AWS_API_SECRET }} | ||||||
| AWS_DEFAULT_REGION: 'us-east-1' | ||||||
Uh oh!
There was an error while loading. Please reload this page.