SEMANTIC VERSIONING KMP

A Kotlin Multiplatform library to work with semantic versioning

Download

implementation("com.javiersc.semver:semver-core:$version")

Usage

A Version must match the following format:

<major>.<minor>.<patch?>-<stage?.name>.<stage?.num>

patch and stage can be null.

Build a `Version`

There are 3 options to build a Version.

Passing a `version: String`

Version("1.0.0")

Version("1.0.0-alpha.1")

Version("12.23.34-alpha.45")

Passing a `version: String` and a `stage: String?`

Version("1.0.0", "alpha.1")

Version("12.23.34", "alpha.45")

Passing all params; `major: Int`, `minor: Int`, `patch: Int?`, `stage: String?`, and `num: Int?`

Version(1, 0, 0)

Version(1, 0, 0, "alpha", 1)

Version(12, 23, 34, "alpha", 45)

Compare two `Version`

Version("1.0.1") > Version("1.0.0") // true 

Version("1.0.1") < Version("1.0.0") // false

Version("1.0.0") == Version("1.0.0") // true

Increase a `Version`

Version("2.4.6-alpha.1").inc(Version.Increase.Patch) // 2.4.7 (stage and num are removed)
Version("2.4.6").inc(Version.Increase.Patch) // 2.4.7
Version("2.4.6").inc(Version.Increase.Minor) // 2.5.0 (patch is reset to 0)
Version("2.4.6").inc(Version.Increase.Major) // 3.0.0 (minor and patch are reset to 0)

// minor and patch are reset to 0, stage and num are removed
Version("2.4.6-beta.4").inc(Version.Increase.Major) // 3.0.0

Copy a `Version`

Version("1.1.0-alpha.1").copy(major = 3) // 3.1.0-alpha.1

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

github-actions

.github/workflows/apply-format.yaml

JavierSegoviaCordoba/reusable-workflows main

.github/workflows/apply-kotlin-upgrade-yarn-lock.yaml

JavierSegoviaCordoba/reusable-workflows main

.github/workflows/build-changelog-renovate-bot.yaml

JavierSegoviaCordoba/reusable-workflows main

.github/workflows/build-kotlin-dispatcher.yaml

JavierSegoviaCordoba/reusable-workflows main

.github/workflows/build-kotlin.yaml

JavierSegoviaCordoba/reusable-workflows main

.github/workflows/dump-api.yaml

JavierSegoviaCordoba/reusable-workflows main

.github/workflows/generate-version-tag.yaml

JavierSegoviaCordoba/reusable-workflows main

.github/workflows/publish-kotlin.yaml

JavierSegoviaCordoba/reusable-workflows main

gradle

gradle.properties

settings.gradle.kts

build.gradle.kts

gradle/libs.versions.toml

com.javiersc.hubdle 0.7.0

semver-core/build.gradle.kts

gradle-wrapper

gradle/wrapper/gradle-wrapper.properties

gradle 8.9

Check this box to trigger a request for Renovate to run again on this repository

javiersegoviacordoba / semantic-versioning-kmp Goto Github PK

semantic-versioning-kmp's Introduction

SEMANTIC VERSIONING KMP

Download

Usage

Build a Version

Passing a version: String

Passing a version: String and a stage: String?

Passing all params; major: Int, minor: Int, patch: Int?, stage: String?, and num: Int?

Compare two Version

Increase a Version

Copy a Version

semantic-versioning-kmp's People

Stargazers

Watchers

semantic-versioning-kmp's Issues