Skip to content
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

DOC: Clarify further remote module version bumps with ITK minor releases #4769

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+6 −3
Open

DOC: Clarify further remote module version bumps with ITK minor releases #4769

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: 6 additions & 3 deletions Documentation/Maintenance/Release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -414,9 +414,12 @@ due to third-party dependencies.

When a new ITK version is released, experience has shown that the remote
module packages are not binary compatible across ITK major or minor releases.
Thus, remote module versions should be bumped into a new major version when
requiring a new ITK major or minor version. The process described below
ensures appropriate versioning and compatibility of the remotes with ITK.
While we attempt to maintain API compatibility between ITK minor releases, the
ABI generally changes. This can be due to features and bug fixes in the ITK
source code, but there are also usually build system changes that cause ABI
changes. Thus, remote module versions should be bumped into a new major
Copy link
Member

@blowekamp blowekamp Jul 5, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, While ITK's main Python packages do not follow semantic versioning, it is recommended that remote module bump the major version when the minor version of ITK change to follow semantic versioning best practices.

Is that clearer?

version when requiring a new ITK major or minor version. The process described
below ensures appropriate versioning and compatibility of the remotes with ITK.

Update Remote Modules
---------------------
Expand Down