Add SemVer checks #3375
Merged
Add SemVer checks #3375
Conversation
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
danieljurek
force-pushed
the
djurek/semver-checks
branch
2 times, most recently
from
c190716 to
726de70
Compare
danieljurek
force-pushed
the
djurek/semver-checks
branch
from
726de70 to
f84e0e2
Compare
API Change CheckAPIView identified API level changes in this PR and created the following API reviews |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds semantic versioning (SemVer) compatibility checks to the Azure SDK for Rust build pipeline using cargo-semver-checks. The changes ensure that package version updates comply with SemVer rules before releases.
Key changes:
- Introduces a new PowerShell script to check SemVer compatibility of packages
- Extracts common cargo metadata functions to a shared module for reuse
- Adds cgmanifest.json to track the cargo-semver-checks tool version used in builds
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| eng/scripts/shared/Cargo.ps1 | New shared module containing reusable cargo metadata and package querying functions |
| eng/scripts/Test-Semver.ps1 | New script that installs cargo-semver-checks and validates package changes against SemVer rules |
| eng/scripts/Pack-Crates.ps1 | Refactored to use shared cargo functions from Cargo.ps1, eliminating duplication |
| eng/pipelines/templates/jobs/pack.yml | Adds SemVer check tasks to both auto and manual service directory build scenarios |
| eng/cgmanifest.json | New manifest tracking cargo-semver-checks version 0.45.0 as a development dependency |
weshaggard
approved these changes
Dec 1, 2025
heaths
reviewed
Dec 2, 2025
Comment on lines
+62
to
+63
| Write-Host "cargo install cargo-semver-checks --locked $($versionParams -join ' ')" | ||
| cargo install cargo-semver-checks --locked @versionParams |
Member
There was a problem hiding this comment.
Why not Invoke-LogCommand or whatever that is we use everywhere else? I see other places it'd work in this PR as well.
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.
eng/cgmanfiest.jsonto track installation of a dev tool in the build systemTest-Semver.ps1uses the version specified ineng/cgmanifest.jsonTested:
Test performance
SemVer checks add a non-trivial amount of time in some OS configurations (Windows, MacOS) because
rust-semver-checksis built.rust-semver-checkbuild times (look at logs for builds of stable in this PR run):Caching considerations
Also discussed here: #3158
Azure DevOps caches are scoped according to several factors. In the case of a PR where speed is most important, we would need a job that runs against
mainto populate a cache that PRs could read. We don't currently schedule PR pipelines to run. In fact, vcpkg, uses its own cache mechanism with relevant rules.If we needed to semver check across OS quickly, we could use a storage account to hold pre-built binaries (similar to vcpkg). The binaries would be built in a Rust pipeline and uploaded to the storage account with a path prefix like
carge-semver-checks/ubuntu-24/0.45.0/. Something would need to update the cache and cgmanifes.json file and proper arrangements would need to be made locally so that callingcargo semver-checkswould use the correct binary.Similar work could also be done to cache source analysis binaries
Other considerations
Checking "nightly" and "msrv" versions of Rust is more complicated. Generally,
cargo-semver-checkssupports "stable" so SemVer checking focuses there.PRs should also block on semver-breaking changes. It may be possible that future version schemes (e.g. adding
-beta.xto a version number) may not block PRs because semver allows breaking changes in-beta.xversions. This will need to be investigated as part of the version incrementing script. We'd either need to adjust the version scheme or update-beta.xat CI execution time.