Add SemVer compatibility checks to CI #445
Merged
tnull merged 2 commits intolightningdevkit:mainfrom Jan 27, 2025
Merged
Conversation
Even small changes to item visibility during fixes might introduce SemVer violations (see https://doc.rust-lang.org/cargo/reference/semver.html#change-categories for a list of changs that would be considered major/minor). To make sure we don't accidentally introduce such changes, we here add a new semver-checks CI job that utilizes cargo-semver-checks (https://github.com/obi1kenobi/cargo-semver-checks), and have it run on any push or pull requests.
We bump the version number on `main` to the next-planned minor release (mod `+git` metadata tag). This aligns what we're planning to do in LDK (see lightningdevkit/rust-lightning#3546) and allows us to run SemVer checks on PRs towards `main`.
jkczyz
approved these changes
Jan 27, 2025
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Even small changes to item visibility during fixes might introduce
SemVer violations (see
https://doc.rust-lang.org/cargo/reference/semver.html#change-categories
for a list of changs that would be considered major/minor).
To make sure we don't accidentally introduce such changes, we here add a
new semver-checks CI job that utilizes cargo-semver-checks
(https://github.com/obi1kenobi/cargo-semver-checks), and have it run on
any push or pull requests.
We also bump the version number on
mainto the next-planned minor release(mod
+gitmetadata tag). This aligns what we're planning to do in LDK(see lightningdevkit/rust-lightning#3546) and
allows us to run SemVer checks on PRs towards
main.