Skip to content

migrate to semver release cycles #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NailxSharipov merged 1 commit into from
Apr 22, 2026
+10 −12
Merged

migrate to semver release cycles #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .github/workflows/tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,15 @@ on:
branches: ["main"]

jobs:
semver:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Run SemVer check
uses: obi1kenobi/cargo-semver-checks-action@v2
with:
manifest-path: iOverlay/Cargo.toml

msrv:
runs-on: ubuntu-latest
steps:
Expand Down
2 changes: 1 addition & 1 deletion iOverlay/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "i_overlay"
version = "4.5.1"
version = "5.0.0"
authors = ["Nail Sharipov <nailxsharipov@gmail.com>"]
edition = "2024"
rust-version = "1.88"
Expand Down
11 changes: 0 additions & 11 deletions iOverlay/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ iOverlay powers polygon boolean operations in [geo](https://github.com/georust/g
- [LineCap](#linecap)
- [LineJoin](#linejoin)
- [FAQ](#faq)
- [Versioning Policy](#versioning-policy)
- [License](#license)

&nbsp;
Expand Down Expand Up @@ -559,16 +558,6 @@ assert_eq!(result.len(), 2);

---

## Versioning Policy

This crate follows a pragmatic versioning approach:

PATCH updates (e.g., 1.8.1 → 1.8.2): Guaranteed to be backward-compatible, containing only bug fixes or small improvements.
MINOR updates (e.g., 1.8.0 → 1.9.0): Typically backward-compatible but may include changes to experimental or less commonly used APIs.
MAJOR updates (e.g., 1.x.x → 2.x.x): Reserved for significant breaking changes or major redesigns.

To minimize disruption, consider pinning dependencies when relying on specific versions.

## License

Licensed under either of:
Expand Down
Loading