Skip to content

Commit

Permalink
Migrate to cthing-projectversion.
Browse files Browse the repository at this point in the history
  • Loading branch information
baron1405 committed May 26, 2024
1 parent 4aa7cb3 commit 2852c3e
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 12 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [unreleased]

### Changed

- Use cthing-projectversion library `ProjectVersion` object for project version

## [3.0.0] - 2024-04-14

### Added
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,9 @@ This project is released on the [Maven Central repository](https://central.sonat
Perform the following steps to create a release.

- Commit all changes for the release
- In the `build.gradle.kts` file
- Ensure that `baseVersion` is set to the version for the release. The project follows [semantic versioning](https://semver.org/).
- Set `isSnapshot` to `false`
- In the `build.gradle.kts` file, edit the `ProjectVersion` object
- Set the version for the release. The project follows [semantic versioning](https://semver.org/).
- Set the build type to `BuildType.release`
- Commit the changes
- Wait until CI builds the release candidate
- Run the command `mkrelease xmlwriter <version>`
Expand All @@ -109,9 +109,9 @@ Perform the following steps to create a release.
- Wait for the new release to be available on Maven Central
- In a browser, go to the project on GitHub
- Generate a release with the tag `<version>`
- In the build.gradle.kts file
- Increment the `baseVersion` patch number
- Set `isSnapshot` to `true`
- In the build.gradle.kts file, edit the `ProjectVersion` object
- Increment the version patch number
- Set the build type to `BuildType.snapshot`
- Update the `CHANGELOG.md` with the changes in the release and prepare for next release changes
- Update the `Usage` section in the `README.md` with the latest artifact release version
- Commit these changes
19 changes: 13 additions & 6 deletions build.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import com.github.spotbugs.snom.Confidence
import com.github.spotbugs.snom.Effort
import org.cthing.projectversion.BuildType
import org.cthing.projectversion.ProjectVersion
import java.text.SimpleDateFormat
import java.util.*

Expand All @@ -18,12 +20,16 @@ plugins {
alias(libs.plugins.versions)
}

val baseVersion = "3.0.1"
val isSnapshot = true
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath(libs.cthingProjectVersion)
}
}

val isCIServer = System.getenv("CTHING_CI") != null
val buildNumber = if (isCIServer) System.currentTimeMillis().toString() else "0"
version = if (isSnapshot) "$baseVersion-$buildNumber" else baseVersion
version = ProjectVersion("3.0.1", BuildType.snapshot)
group = "org.cthing"
description = "A simple yet highly configurable XML writing library."

Expand Down Expand Up @@ -204,7 +210,8 @@ publishing {
}
}

val repoUrl = if (isSnapshot) findProperty("cthing.nexus.snapshotsUrl") else findProperty("cthing.nexus.candidatesUrl")
val repoUrl = if ((version as ProjectVersion).isSnapshotBuild)
findProperty("cthing.nexus.snapshotsUrl") else findProperty("cthing.nexus.candidatesUrl")
if (repoUrl != null) {
repositories {
maven {
Expand Down
1 change: 1 addition & 0 deletions gradle/libs.versions.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ versions = { id = "com.github.ben-manes.versions", version = "0.51.0" }
apiGuardian = "org.apiguardian:apiguardian-api:1.1.2"
assertJ = "org.assertj:assertj-core:3.25.3"
cthingAnnots = "org.cthing:cthing-annotations:1.0.0"
cthingProjectVersion = "org.cthing:cthing-projectversion:1.0.0"
escapers = "org.cthing:escapers:1.0.0"
jsr305 = "com.google.code.findbugs:jsr305:3.0.2"
junitApi = { module = "org.junit.jupiter:junit-jupiter-api", version.ref = "junit" }
Expand Down

0 comments on commit 2852c3e

Please sign in to comment.