add nanpa version management support #434
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
this adds support for versioning through [nanpa](https://github.com/nbsp/nanpa), via the [ilo](https://github.com/nbsp/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"`. `type`s follow [Keep a Changelog](https://keepachangelog.org). 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: - add [ilo](https://github.com/apps/ilo-nanpa) to the repository - set the `NANPA_WORKFLOW` environmental variable to `publish.yml`, for CI (not as a secret!)
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 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
this adds support for versioning through nanpa, via the ilo GitHub bot.
usage guide
on PRs, for each change, add a file to
.nanpa/<unique-name>.kdl, that looks like this:alternatively you may add the file to
./livekit-ffi/.nanpa/, and then drop thepackage="livekit-ffi".types follow Keep a Changelog. you may add multiple lines per file.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:
or to un-prerelease a package:
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
NANPA_WORKFLOWenvironmental variable topublish.yml, for CI (not as a secret!)