Skip to content

Latest commit

 

History

History
367 lines (258 loc) · 9.6 KB

CHANGELOG.md

File metadata and controls

367 lines (258 loc) · 9.6 KB

Changelog

6.4.2

Fixes
  • handle tags within git worktrees directories

6.4.1

Fixes
  • threat empty circleCI environment variables as not set

6.4.0

Features
  • add option describeTagFirstParent option to disable follow first parent only

6.3.8

Fixes

-prevent version task to be registered multiple times #111 (kudos to @taichi)

6.3.7

Features
  • add visible logging for relevant output
Fixes
  • ignore ci/cd environment if head SHA hash is not matching environment variable commit hash

6.3.6

Fixes
  • fix value of describe.tag.version placeholder

6.3.5

Fixes
  • Improve compatibility with Gradle Configuration Cache #99

6.3.4

Fixes
  • Only register version task for the current project #97
  • Fix version pattern matcher. Ensure that matching groups are available. #96

6.3.3

Fixes
  • Fixes describe.tag.version.label #95

6.3.2

Fixes
  • Extend gitlab ci support for env var CI_MERGE_REQUEST_SOURCE_BRANCH_NAME

6.3.0

Features
  • add new placeholders
    • ${describe.tag.version.patch.plus.describe.distance}
    • ${describe.tag.version.patch.next.plus.describe.distance}
    • ${describe.tag.version.label.plus.describe.distance}
    • ${describe.tag.version.label.next.plus.describe.distance}

6.2.0

Features
  • add config option for projectVersionPattern to use special parts of the project version as placeholders e.g. ${version.environment}
  • add placeholder ${version.core} the core version component of ${version} e.g. '1.2.3'
    • ${version.release} is marked as deprecated

6.1.6

Fixes
  • handle lightweight tags
  • set ${version.minor.next} placeholders properly

6.1.5

Fixes
  • version.label.prefixed resolve to empty string if version.label is empty

6.1.4

Fixes
  • fix incompatibility with jre 8

6.1.3

Fixes
  • fix git describe tag selection, if multiple tags point to head

6.1.1

Fixes
  • do not consider project properties for command options anymore
  • prefer cli options e.g. -Dgit.ref=... over environment variables e.g. VERSIONING_GIT_REF=...)

6.1.0

Features
  • placeholder
    • new
      • ${version.major.next}
      • ${version.minor.next}
      • ${version.patch.next}
      • ${describe.tag.version}
      • ${describe.tag.version.major}
      • ${describe.tag.version.major.next}
      • ${describe.tag.version.minor}
      • ${describe.tag.version.minor.next}
      • ${describe.tag.version.path}
      • ${describe.tag.version.patch.next}
    • removed
      • ${version.minor.prefixed}
      • ${version.patch.prefixed}

6.0.0

Features
  • migrate to java 11
Fixes
  • migrate describeTagPattern config fields from Pattern to String
BREAKING CHANGES
  • drop support for java 8

5.2.0

Features
  • add additional version component placeholders (#182)
  • ${version.minor.prefixed} like ${version.minor} with version component separator e.g. '.2'
  • ${version.patch.prefixed} like ${version.patch} with version component separator e.g. '.3'
  • ${version.label} the version label of ${version} e.g. 'SNAPSHOT'
    • ${version.label.prefixed} like ${version.label} with label separator e.g. '-SNAPSHOT'

5.1.5

Fixes
  • replace deprecated class ConfigureUtil

5.1.4

Fixes
  • fix worktree handling

5.1.3

Fixes
  • fix rootDirectory determination for sub working trees

5.1.2

Fixes
  • groovy add special properties_ field to work around groovy naming conflict of properties filed from groovy.lang.MetaClass

5.1.1

Fixes
  • if a tag is provided (and no branch) the extension behaves like in detached head state
  • if a branch is provided (and no tag) the extension behaves like in attached head state with no tags pointing to head

5.1.0

Features
  • New Placeholder ${commit.timestamp.year.2digit}

5.0.0

Features

  • Add GitHub Actions, GitLab CI and Jenkins environment variable support

    • GitHub Actions: if $GITHUB_ACTIONS == true, GITHUB_REF is considered
    • GitLab CI: if $GITLAB_CI == true, CI_COMMIT_BRANCH and CI_COMMIT_TAG are considered
    • Circle CI: if $CIRCLECI == true, CIRCLE_BRANCH and CIRCLE_TAG are considered
    • Jenkins: if JENKINS_HOME is set, BRANCH_NAME and TAG_NAME are considered

  • Simplify configuration (also see BREAKING CHANGES)

    Groovy DSL Example: build.gradle

    version = '0.0.0-SNAPSHOT'
gitVersioning.apply {
    refs {
        branch('.+') {
            version = '${ref}-SNAPSHOT'
        }
        tag('v(?<version>.*)') {
            version = '${ref.version}'
        }
    }
    
    // optional fallback configuration in case of no matching ref configuration
    rev {
        version = '${commit}'
    }
}

    Kotlin DSL Example: build.gradle.kts

    version = "0.0.0-SNAPSHOT"
gitVersioning.apply {
    refs {
        branch(".+") {
            version = "\${ref}-SNAPSHOT"
        }
        tag('v(?<version>.*)') {
            version = "\${ref.version}"
        }
    }
    
    // optional fallback configuration in case of no matching ref configuration
    rev {
        version = "\${commit}"
    }
}

  • New option to consider tag configs on branches (attached HEAD), enabled by refs { considerTagsOnBranches = true }

    • If enabled, first matching branch or tag config will be used for versioning
BREAKING CHANGES
  • There is no default config anymore, if no ref configuration is matching current git situation and no rev configuration has been defined a warning message will be logged and plugin execution will be skipped.
  • Placeholder Changes (old -> new)
    • ${branch} -> ${ref}
    • ${tag} -> ${ref}
    • ${REF_PATTERN_GROUP} -> ${ref.REF_PATTERN_GROUP}
    • ${describe.TAG_PATTERN_GROUP} -> ${describe.tag.TAG_PATTERN_GROUP}
  • preferTags option was removed
    • use refs { considerTagsOnBranches = true } instead

4.3.0

  • Features

    • add git describe version placeholders
      • new placeholders
        • ${describe}
        • ${describe.tag}
          • ${describe.<TAG_PATTERN_GROUP_NAME or TAG_PATTERN_GROUP_INDEX>} e.g. pattern v(?<version>.*) will create placeholder ${describe.version}
        • ${describe.distance}

  • BREAKING CHANGES

    • no longer provide project property git.dirty due to performance issues on larger projects, version format placeholder ${dirty} is still available

4.1.0

  • Features
    • add ability to define default or overwrite values for version and property format.
      • default value if parameter value is not set ${paramter:-<DEFAULT_VALUE>} e.g. ${buildNumber:-0}
      • overwrite value if parameter has a value ${paramter:+<OVERWRITE_VALUE>} e.g. ${dirty:+-SNAPSHOT}

4.0.0 - Major refactoring

  • Features
    • Add option to disable plugin by default and enable on demand.
    • Add option to modify project gradle.properties file accordingly to plugin related changes.
      • commandline property gradle ... -Pversioning.updateGradleProperties
      • Environment variable OPTION_UPDATE_GRADLE_PROPERTIES=true
      • Plugin Config updateGradleProperties=true global and branch/tag specific.
    • Project <Dependency> and <Plugin> versions will be updated accordingly to git versions
    • Add config option <disable>true</disable> to disable extension by default.
    • Add format placeholder:
      • ${dirty.snapshot}
      • ${commit.timestamp.year}
      • ${commit.timestamp.month}
      • ${commit.timestamp.day}
      • ${commit.timestamp.hour}
      • ${commit.timestamp.minute}
      • ${commit.timestamp.second}
      • Gradle CLI properties e.g. gradle ... -Pfoo=bar will be accessible by ${foo} placeholder
  • BREAKING CHANGES
    • default version format on a branch changed to ${branch}-SNAPSHOT was ${commit}
    • Replace property regex pattern match with simple name match
      • old regex pattern config branch|tag|commit { property { pattern = 'abc' } }
      • new property name config branch|tag|commit { property { name = 'abc' } }
    • Remove property value pattern branch|tag|commit { property { valuePattern = 'xyz' } }
    • Remove format placeholder ${property.name}
    • Rename format placeholder ${property.value} to just ${value}
    • Remove CommitVersionDescription, use VersionDescription instead.

3.0.0

Features

  • simplify property replacement configuration

Breaking Changes

  • simplify property replacement configuration

    new config

    gitVersioning.apply {
  branch {
    pattern = 'master'
    versionFormat = '${version}'
    property {
      pattern = 'revision'
      valueFormat = '${branch-SNAPSHOT}'
    }
  }
}

    old config

    gitVersioning.apply {
  branch {
    pattern = 'master'
    versionFormat = '${version}'
    property {
      pattern ='revision'
      value {
        format = '${branch-SNAPSHOT}'
      }
    }
  }
}

2.1.0

  • add ${dirty} flag version format placeholder
  • add git.dirty property

2.0.0

Breaking Changes

  • New way of applying git versioning
    • You need to call apply method with config, after version was set. 
      version = '0.0.0-SNAPSHOT'
gitVersioning.apply {
  // see configuration documentatiomn above
}