Use SNAPSHOT version when there are local changes

[big-andy-coates]

I've noticed that at some point, as I've been upgrading this awesome release plugin, that it stopped appending -SNAPSHOT when there were local uncommitted changes.

I've scanned the docs, but couldn't find how to reinstate this functionality. Could you point me in the right direction please? The only thing I've got to work so far is this, which is pretty ugly:

scmVersion {
    versionCreator { version, _ ->
        val hasUncommittedChanges = providers.exec { 
            commandLine("git", "status", "--porcelain") 
        }.standardOutput.asText.get().trim().isNotEmpty()
        
        val currentBranch = providers.exec { 
            commandLine("git", "rev-parse", "--abbrev-ref", "HEAD") 
        }.standardOutput.asText.get().trim()
        
        if (hasUncommittedChanges) {
            val parts = version.split(".")
            val major = parts[0].toInt()
            val minor = parts[1].toInt()
            val patch = parts[2].toInt() + 1
            val baseVersion = "${major}.${minor}.${patch}"
            
            if (currentBranch != "main") {
                "${baseVersion}-${currentBranch}-SNAPSHOT"
            } else {
                "${baseVersion}-SNAPSHOT"
            }
        } else {
            version
        }
    }
}

TBH, I'm a little confused why the default has changed, given I'd assume most users would want a snapshot build when building code that doesn't exactly match the tag...

[bgalek]

Hi, if that happend, it was unintended. I did not experience this behaviour "on production", could you create a example repo with the problem?

[big-andy-coates]

Hey @bgalek,

Appreciate the quick response!

It's not a minimal example (sorry, time...), but if you pull down the open source project: https://github.com/specmesh/specmesh-build, I can use it to demonstrate the issue.

At the time of writing, its on v0.17.1.

I'm on a Mac, adjust commands as needed, but roughly:

# Clone it
git clone https://github.com/specmesh/specmesh-build.git
cd specmesh-build

# Check current version:
./gradlew -q cV

# output: Project version: 0.17.1

# Make a local change:
touch something

# Check current version:
./gradlew -q cV

# output: Project version: 0.17.1, but was expecting 0.17.2-SNAPSHOT

Repo is using id("pl.allegro.tech.build.axion-release") version "1.19.0", same issue if upgraded to 1.20.1.

[bgalek]

I'll check it out in next few days!

[big-andy-coates]

Hummm... found an option that helps. This causes it to add the -SNAPSHOT if there are uncommitted changes:

scmVersion {
    ignoreUncommittedChanges.set(false)
}

Has the default of ignoreUncommittedChanges changed to true?

[bgalek]

I did not find any change that could affect that, I'll prepare a test case for this particular case