Skip to content

Release with verwalter - #397

Open
lukasIO wants to merge 2 commits into
mainfrom
lukas/verwalter
Open

lukasIO wants to merge 2 commits into
mainfrom
lukas/verwalter

Conversation

@lukasIO

@lukasIO lukasIO commented Nov 13, 2026 •

Copy link
Copy Markdown

A release today is a manual sequence: run Scripts~/prepare_release.py with the new SDK version, open a PR, then push the tag and write the GitHub release by hand. The release notes depend on what the maintainer remembers. The 2.1.1 notes are one line.

Change

verwalter now releases the package.

  • Each PR that changes the package adds a changeset file in .changeset/. changeset-check.yml fails a PR without one, unless it has the internal label.
  • Each push to main updates one release PR (release-pr.yml). It bumps package.json, the changelogUrl in it and the tag example in the README, and writes CHANGELOG.md.
  • Merging the release PR tags vX.Y.Z and creates the GitHub release (release.yml). The tag format does not change, so git URL installs and OpenUPM continue to work.
  • pre-release.yml opens an rc PR on demand.

Scripts~/prepare_release.py now takes the FFI version only. It still updates version.ini, the binaries, the submodule and the protobuf code, but it no longer writes package.json.

CHANGELOG.md starts with the next release. Earlier notes stay on the releases page. The README example moves from #v1.3.5 to #v2.1.1.

The release PR gets the release label. ci.yml already reads that label and tests against the committed FFI binaries, which is correct for a release PR.

Verified

  • verwalter plan: 1 package, 0 pending changesets, no warnings.
  • verwalter status: 2.1.1, tag and GitHub release present, up to date.
  • verwalter pr --dry-run with a temporary minor changeset: the release branch moved package.json, changelogUrl and the README example to 2.2.0 and added the changelog entry.

For reviewers

  • Create the internal label and add it to this PR. The changeset check fails until then.
  • verwalter overwrites the description of the release label with "Release PR managed by verwalter".

Not done yet

  • No workflow ran yet. The first push to main after the merge is the first real run.

🤖 Generated with Claude Code

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
@lukasIO lukasIO self-assigned this Nov 13, 2026
@lukasIO lukasIO added the internal for PRs that don't need a changeset label Nov 13, 2026
@lukasIO
lukasIO marked this pull request as ready for review November 13, 2026 10:49
devin-ai-integration[bot]

This comment was marked as resolved.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
Comment thread CHANGELOG.md
@@ -0,0 +1,3 @@
# Changelog

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.

So this file will accumulate changelogs or just hold the ones from the last release? Is this a 1:1 copy from the changeset files in the end?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

This will accumulate and end up looking like this https://github.com/livekit/client-sdk-js/blob/main/CHANGELOG.md

Comment thread verwalter.toml
Comment on lines +6 to +8
"package.json",
{ path = "package.json", regex = 'releases/tag/v(?<version>[^"]+)' },
{ path = "README.md", regex = '`#v(?<version>\d[^`]*)`' },

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.

Why is package.json listed here once standalone and once in the { path, regex } pattern? Is the standalone using a default regex?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

exactly. package.json -> version is covered as a well-known default.
Unity's package.json extensions also have the changeLogUrl which isn't part of the plain package.json manifest, so it gets its own regex expression. Jacob has some ideas to make this more robust in the future (regex could match multiple today without anyone noticing).

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

internal for PRs that don't need a changeset

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants