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

fix #155 by extracting version without suffix #175

Merged
merged 5 commits into from
Aug 3, 2023
Merged

fix #155 by extracting version without suffix #175

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3738510
fix scalacenter/sbt-version-policy#155 by extracting sem. version wit…
Jul 28, 2023
7f62e65
ignore sem.version suffix only for current version in source compat c…
Aug 2, 2023
e21ee29
implement suffix checks for semver patch version changes
Aug 2, 2023
52be291
simplify semver patch comparison in source compatibility check
Aug 3, 2023
a036565
add 'sbtversionpolicy.DependencyCheckReport$SemVerVersion*' to MIMA f…
Aug 3, 2023
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
8 changes: 8 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
# SBT stuff
target/

# Bloop/Metals/VSCode stuff
.bloop
.bsp
.metals
.vscode
metals.sbt
10 changes: 6 additions & 4 deletions sbt-version-policy/src/main/scala/sbtversionpolicy/DependencyCheckReport.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,10 +167,12 @@ object DependencyCheckReport {

private def extractSemVerNumbers(versionString: String): Option[(Int, Int, Int)] = {
val version = Version(versionString)
if (version.items.size == 3 && version.items.forall(_.isInstanceOf[Version.Number])) {
val Seq(major, minor, patch) = version.items.collect { case num: Version.Number => num.value }
Some((major, minor, patch))
} else None // Not a normalized version number (e.g., 1.0.0-RC1)
version.items match {
case Vector(major: Version.Number, minor: Version.Number, patch: Version.Number, _*) =>
Some((major.value, minor.value, patch.value))
case _ =>
None // Not a semantic version number (e.g., 1.0-RC1)
}
}

}
5 changes: 4 additions & 1 deletion sbt-version-policy/src/test/scala/sbtversionpolicy/DependencyCheckReportTest.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,11 @@ object DependencyCheckReportTest extends BasicTestSuite {
isCompatible("1.0.1", "1.0.0")
isBreaking ("1.1.0", "1.0.0")
isBreaking ("2.0.0", "1.0.0")
isBreaking ("1.0.0", "1.0.0-RC1")
isBreaking ("1.1.0", "1.0.0-RC1")
isBreaking ("2.0.0", "1.0.0-RC1")
isCompatible("1.0.0-RC1", "1.0.0-RC1")
isCompatible("1.0.0", "1.0.0-RC1")
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is inconsistent with what versions does, see https://scastie.scala-lang.org/LQVPcpnLSuqRzz9z8J4jQA.

We should ignore the suffix of the current version only (as in https://scastie.scala-lang.org/miZPzsvfS7mrB6FGoyMVEQ).

So, we should have the following assertions:

isBreaking("1.0.0", "1.0.0-RC1")
isBreaking("1.0.1", "1.0.0-RC1")
isBreaking("1.1.0", "1.0.0-RC1")
isBreaking("2.0.0", "1.0.0-RC1")
isCompatible("1.0.0-RC1", "1.0.0-RC1")
isCompatible("1.1.0-RC1", "1.0.0")
isCompatible("1.2.1-SNAPSHOT", "1.2.0")

Copy link
Author

Choose a reason for hiding this comment

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

I've changed logic to ignore suffix only for current version with just one note: isCompatible("1.1.0-RC1", "1.0.0") => isCompatible("1.0.1-RC1", "1.0.0"), because 1.1.0 is allowed to be source incompatible.

This leads to question: what should we do with changes in suffix? Should RC2 vs RC1 or RC1 vs SNAPSHOT be assumed compatible or not?

isCompatible("1.0.1", "1.0.0-RC1")
}
}

Expand Down