v1.18.8

What's Changed

Changed

When using releaseOnlyOnReleaseBranches verifyRelease tasks were not skipped.
From now, gradle release task and it's dependants will be skipped if releaseOnlyOnReleaseBranches is active and the plugin decides to skip the release.

• Disable release tasks if release should be skipped by @radoslaw-panuszewski in #813

Dependency updates

• Bump mkdocs-material from 9.5.33 to 9.5.34 by @dependabot in #804
• Bump pl.allegro.tech.build.axion-release from 1.18.5 to 1.18.7 by @dependabot in #803
• Bump com.gradle.plugin-publish from 1.2.1 to 1.2.2 by @dependabot in #801
• Bump mkdocs from 1.6.0 to 1.6.1 by @dependabot in #805

Full Changelog: v1.18.7...v1.18.8

v1.18.7

What's Changed

Bugfix

With releaseOnlyOnReleaseBranches property set,
when a release is skipped, GITHUB_OUTPUT is not written anymore.

• ScmPushResultOutcome introduced by @bgalek in #800

Full Changelog: v1.18.6...v1.18.7

v1.18.6

What's Changed

Changed

🎉 Achieving a workflow with one-liner gradle step: ./gradew build release publish is now possible!

Setting releaseOnlyOnReleaseBranches option

scmVersion {
    releaseOnlyOnReleaseBranches = true
}

Will make release task no-operation, if run on feature branches (not main/master).

You can further customize release branch name list, using releaseBranchNames property:

scmVersion {
    releaseOnlyOnReleaseBranches = true
    releaseBranchNames = ['main', 'master']
}

• releaseOnlyOnReleaseBranches & releaseBranchNames options by @bgalek in #797

Based on users feedback it may be set to default in future releases :)

Dependency updates

• Bump mkdocs-material from 9.5.31 to 9.5.32 by @dependabot in #794
• Bump pl.allegro.tech.build.axion-release from 1.18.4 to 1.18.5 by @dependabot in #795
• Bump mkdocs-material from 9.5.32 to 9.5.33 by @dependabot in #798

Full Changelog: v1.18.5...v1.18.6

v1.18.5

What's Changed

Changed

Introducing fallbackPrefixes that can be used to migrate from one tag prefix to another.

Usage:

scmVersion {
    tag {
        prefix.set("new-prefix-")
        fallbackPrefixes.set(listOf("old-prefix-"))
    }
}

Implement support for fallback tag prefixes by @radoslaw-panuszewski in #793

Dependency updates

• Bump com.github.mwiede:jsch from 0.2.18 to 0.2.19 by @dependabot in #792

Full Changelog: v1.18.4...v1.18.5

v1.18.4

What's Changed

Changed

We continue streamlining GitHub Workflows (and CI runtimes in general).

This release is introducing unshallowRepoOnCI incubating option,
that will unshallow the git repository, so the axion-release-plugin can successfully read tags history despite your CI clone strategy.

Usage:

scmVersion {
    unshallowRepoOnCI.set(true)
}

Now, you can simplify your GitHub Actions config:

steps:
  - uses: actions/checkout@v4
-   with:
-     fetch-depth: 0

After more testing with other CI pipelines, this option will probably be enabled by default.

• Unshallow repo on CI by @radoslaw-panuszewski in #790

Dependency updates

• Bump org.apache.sshd:sshd-core from 2.13.1 to 2.13.2 by @dependabot in #787
• Bump pl.allegro.tech.build.axion-release from 1.18.2 to 1.18.3 by @dependabot in #785
• Bump mkdocs-material from 9.5.30 to 9.5.31 by @dependabot in #784
• Bump org.apache.sshd:sshd-git from 2.13.1 to 2.13.2 by @dependabot in #786

Full Changelog: v1.18.3...v1.18.4

v1.18.3

What's Changed

• #761 | Fix released-version output reporting SNAPSHOT version by @radoslaw-panuszewski in #783

Dependencies

• Bump pl.allegro.tech.build.axion-release from 1.18.0 to 1.18.2 by @dependabot in #781
• Bump mkdocs-material from 9.5.29 to 9.5.30 by @dependabot in #782

Full Changelog: v1.18.2...v1.18.3

v1.18.2

What's Changed

• Fix for GITHUB_HEAD_REF having empty value by @radoslaw-panuszewski in #779

Full Changelog: v1.18.1...v1.18.2

v1.18.1

New behavior

From now on, on GitHub Workflows, you don't need to check out ref for axion-release-plugin to know what branch your build is being run on—it will be read from the GitHub workflow environment variable (GITHUB_HEAD_REF).

steps:
  - uses: actions/checkout@v4
    with:
      fetch-depth: 0
-     ref: ${{ github.head_ref }}

What's Changed

• Read ref from GITHUB_HEAD_REF env variable if it's present by @radoslaw-panuszewski in #776

Dependencies

• Bump mkdocs-material from 9.5.27 to 9.5.28 by @dependabot in #774
• Bump pl.allegro.tech.build.axion-release from 1.17.2 to 1.18.0 by @dependabot in #773
• Bump mkdocs-material from 9.5.28 to 9.5.29 by @dependabot in #778

New Contributors

• @radoslaw-panuszewski made their first contribution in #776

Full Changelog: v1.18.0...v1.18.1

v1.18.0

What's Changed

#772

This release addresses a common issue with code collaboration using this plugin, particularly when multiple feature branches are being developed simultaneously from the same HEAD.

Problem

Until now, the plugin used a SIMPLE version creator by default, which did not decorate version in any way.

This default setting led to the following issues:

• Both feature branches would generate the same version (e.g., v0.0.1-SNAPSHOT).
• During publication, this resulted in overridden snapshots, as Maven allows overwriting SNAPSHOT versions.

Solution

This release changes the default versionCreator to VERSION_WITH_BRANCH.

The new behavior includes:

• Appending the branch name to the version (e.g., v0.0.1-my-branch-name-SNAPSHOT).
• Falling back to the SIMPLE version creator for detached HEAD checkouts, maintaining the old behavior in such cases.

Breaking change

• Versions will now include the branch name, preventing the override of snapshots across different branches.

Migration Guide

To continue using the SIMPLE version creator, update your plugin configuration as follows:

scmVersion {
    versionCreator('simple')
}

Additional changes

• improve ci_servers.md GitLab CI branch override by @doofy in #760
• Use forUseAtConfigurationTime only for lower Gradle versions by @kkocel in #765

Dependencies

• Bump mkdocs-material from 9.5.20 to 9.5.25 by @dependabot in #763
• Bump org.objenesis:objenesis from 3.3 to 3.4 by @dependabot in #753
• Bump pl.allegro.tech.build.axion-release from 1.17.1 to 1.17.2 by @dependabot in #752
• Bump org.apache.sshd:sshd-git from 2.12.1 to 2.13.1 by @dependabot in #771
• Bump mkdocs-material from 9.5.25 to 9.5.27 by @dependabot in #769
• Bump org.apache.sshd:sshd-core from 2.12.1 to 2.13.1 by @dependabot in #770
• Bump com.github.mwiede:jsch from 0.2.17 to 0.2.18 by @dependabot in #766
• Bump jgitVersion from 6.9.0.202403050737-r to 6.10.0.202406032230-r by @dependabot in #768

New Contributors

• @doofy made their first contribution in #760

Full Changelog: v1.17.2...v1.18.0

v1.17.2

What's Changed

• output released version in github actions environement by @bgalek in #737

Dependencies

• Bump pl.allegro.tech.build.axion-release from 1.17.0 to 1.17.1 by @dependabot in #748
• Bump mkdocs-material from 9.5.18 to 9.5.20 by @dependabot in #747

Full Changelog: v1.17.1...v1.17.2