livekit / rust-sdks

LiveKit realtime and server SDKs for Rust
https://livekit.io
Apache License 2.0
212 stars 57 forks source link

add nanpa version management support #434

Closed nbsp closed 2 months ago

nbsp commented 2 months ago

this adds support for versioning through nanpa, via the ilo GitHub bot.

usage guide

  1. on PRs, for each change, add a file to .nanpa/<unique-name>.kdl, that looks like this:

    patch type="added" package="livekit-ffi" "Add support for foo"

    alternatively you may add the file to ./livekit-ffi/.nanpa/, and then drop the package="livekit-ffi".

    types follow Keep a Changelog. you may add multiple lines per file.

  2. ilo will create an issue when there's changes in the main branch. use the checkboxes to pick which ones you want to bump. additionally, if you want to set a prerelease version on a package:

    ilo prerelease rust-sdks/livekit-ffi alpha

    or to un-prerelease a package:

    ilo prerelease rust-sdks/livekit-ffi

  3. close the issue, and the workflow should run, making a new commit and tagging it with all changed package versions.

note that when updating a package and its dependent, you need to either bump them seperately, or manually update the dependency's Cargo.toml, and then edit the dependent's manifest to include the new dep version.

repo settings that need to change

davidzhao commented 2 months ago

on PRs, for each change, add a file to .nanpa/.kdl, that looks like this:

It'd be great to have automation for this, otherwise it'd be easy for devs to forget.

nbsp commented 2 months ago

on PRs, for each change, add a file to .nanpa/.kdl, that looks like this:

It'd be great to have automation for this, otherwise it'd be easy for devs to forget.

i can always add this to the bot later (as a PR comment with a link), without any changes here