Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/philippus/bump
💥 Bump the semantic version for your next release :shipit:
https://github.com/philippus/bump
parser-combinators scala semantic-versioning
Last synced: 3 months ago
JSON representation
💥 Bump the semantic version for your next release :shipit:
- Host: GitHub
- URL: https://github.com/philippus/bump
- Owner: Philippus
- License: mit
- Created: 2018-03-29T14:58:42.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2024-10-20T19:57:23.000Z (3 months ago)
- Last Synced: 2024-10-21T00:29:45.823Z (3 months ago)
- Topics: parser-combinators, scala, semantic-versioning
- Language: Scala
- Homepage:
- Size: 332 KB
- Stars: 9
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Bump - Semantic Versioning
[](https://github.com/Philippus/bump/actions/workflows/scala.yml?query=workflow%3Abuild+branch%3Amain)
[](https://codecov.io/gh/Philippus/bump)
[](LICENSE.md)
Bump is a library for working with semantic versioning following the [Semantic Versioning 2.0.0](https://semver.org/)
specification. It supports validation, precedence comparison, and increasing version numbers.
A `SemVer` object representing the version can be created by supplying arguments for the `version`, `preRelease` and
`buildMetaData` parts to the constructor or by supplying a string which will be parsed by the `SemVerParser` using
[parser combinators](https://github.com/scala/scala-parser-combinators).
## Installation
Bump is published for Scala 2.13. To start using it add the following to your `build.sbt`:
```
libraryDependencies += "nl.gn0s1s" %% "bump" % "0.1.3"
```
## Example usage
```scala
import nl.gn0s1s.bump._
val version = SemVer(1, 0, 1, Some("alpha"), Some("20180329")) // version: nl.gn0s1s.bump.SemVer = 1.0.1-alpha+20180329
version.nextMinor.withoutPreRelease.withoutBuildMetadata // res0: nl.gn0s1s.bump.SemVer = 1.1.0
val version2 = SemVer("2.0.0").get // version2: nl.gn0s1s.bump.SemVer = 2.0.0
version < version2 // res1: Boolean = true
version2.nextPatch // res2: nl.gn0s1s.bump.SemVer = 2.0.1
val invalidVersion = SemVer("3.0") // invalidVersion: Option[nl.gn0s1s.bump.SemVer] = None
```
## Methods
The following methods are available on a `SemVer` object:
* `toString` - returns the semantic versioning 2.0.0 string
* `compare` - compares the precedence to the supplied SemVer
* `nextMajor`/`bumpMajor` - returns a new SemVer with an incremented `major` and reset (0) `minor` and `patch` version numbers
* `nextMinor`/`bumpMinor` - returns a new SemVer with an incremented `minor` and a reset (0) `patch` version number
* `nextPatch`/`bumpPatch` - returns a new SemVer with an incremented `patch` version number
* `nextStable` - returns a new SemVer without pre-release information or an incremented `patch` version number
* `withMajor` - returns a new SemVer with the supplied `major` version number
* `withMinor` - returns a new SemVer with the supplied `minor` version number
* `withPatch` - returns a new SemVer with the supplied `patch` version number
* `withPreRelease` - returns a new SemVer with the supplied `preRelease` string
* `withoutPreRelease` - returns a new SemVer without pre-release information
* `withBuildMetadata` - returns a new SemVer with the supplied `buildMetadata` string
* `withoutBuildMetadata` - returns a new SemVer without build metadata
## Links
- [Semantic Versioning 2.0.0](https://semver.org/)
## License
The code is available under the [MIT license](LICENSE.md).