Skip to content

Commit 0f4854a

Browse files
committed
docs: Update version range docs to not be limited to Ivy
Signed-off-by: Sebastian Schuberth <[email protected]>
1 parent 1fad42a commit 0f4854a

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

model/src/main/kotlin/PackageCuration.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ data class PackageCuration(
5555
/**
5656
* Return true if this [PackageCuration] is applicable to the package with the given [identifier][pkgId]. The
5757
* curation's version may be an
58-
* [Ivy version matcher](http://ant.apache.org/ivy/history/2.4.0/settings/version-matchers.html).
58+
* [Ivy, NPM, or CocoaPods version range](https://github.com/semver4j/semver4j?tab=readme-ov-file#external).
5959
*/
6060
fun isApplicable(pkgId: Identifier): Boolean =
6161
isApplicableDisregardingVersion(pkgId)

model/src/main/kotlin/config/PackageConfiguration.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ data class PackageConfiguration(
4444
/**
4545
* The [Identifier] which must match with the identifier of the package in order for this package curation to apply.
4646
* The [version][Identifier.version] can be either a plain version string matched for equality, or an
47-
* [Ivy-style version matchers](https://ant.apache.org/ivy/history/2.5.0/settings/version-matchers.html).
47+
* [Ivy, NPM, or CocoaPods version range](https://github.com/semver4j/semver4j?tab=readme-ov-file#external).
4848
* The other components of the [identifier][id] are matched by equality.
4949
*/
5050
val id: Identifier,

model/src/main/kotlin/utils/VersionUtils.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ import org.semver4j.RangesListFactory
2828
import org.semver4j.Semver
2929

3030
/**
31-
* Return true if the version of this [Identifier] interpreted as an Ivy version matcher is applicable to the
32-
* package with the given [identifier][pkgId].
31+
* Return true if the version of this [Identifier] interpreted as an Ivy, NPM or CocoaPods version range is applicable
32+
* to the package with the given [identifier][pkgId].
3333
*/
3434
internal fun Identifier.isApplicableIvyVersion(pkgId: Identifier) =
3535
runCatching {

website/docs/configuration/package-configurations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Use a package configuration file to:
1414
## Package Configuration File Basics
1515

1616
A package configuration applies to the packages it matches with.
17-
It contains the mandatory `id` matcher, for matching package IDs, which allows for using [Ivy-style version matchers](https://ant.apache.org/ivy/history/2.5.0/settings/version-matchers.html).
17+
It contains the mandatory `id` matcher, for matching package IDs, which allows for using [Ivy, NPM, or CocoaPods version ranges](https://github.com/semver4j/semver4j?tab=readme-ov-file#external).
1818
In addition to the `id`, at most one of the matchers `vcs`, `sourceArtifactUrl` or `sourceCodeOrigin` may additionally
1919
be specified, which targets the repository provenance, the source artifact provenance or just the source code origin of
2020
the package's scan result(s).

0 commit comments

Comments
 (0)