Skip to content

Commit

Permalink
#387 Gradle configuration cache compatibility - rebased (#516)
Browse files Browse the repository at this point in the history
* #387 Gradle configuration cache compatibility

* #387 attempt to fix mysterious CI build failure

* fixing maven jar publication problems

* Update ci.yml

* fixing maven jar publication problems

* fixing maven jar publication problems

* Update build.gradle

* setAutomatedPublishing set to default (true) (#486)

* MavenPublication artifact changed

* publishing artifact configuration changed

* Bump mkdocs-material from 8.2.16 to 8.3.2 (#485)

Bumps [mkdocs-material](https://github.com/squidfunk/mkdocs-material) from 8.2.16 to 8.3.2.
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](squidfunk/mkdocs-material@8.2.16...8.3.2)

---
updated-dependencies:
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Update README.md

* Update README.md

* fix: customize pom, not create another publication (#487)

* Update publish.yml

* Implement #480: handle empty overriddenBranchName same as not set (#489)

* Bump pl.allegro.tech.build.axion-release from 1.13.9 to 1.13.14 (#496)

Bumps [pl.allegro.tech.build.axion-release](https://github.com/allegro/axion-release-plugin) from 1.13.9 to 1.13.14.
- [Release notes](https://github.com/allegro/axion-release-plugin/releases)
- [Commits](v1.13.9...v1.13.14)

---
updated-dependencies:
- dependency-name: pl.allegro.tech.build.axion-release
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump mkdocs-material from 8.3.2 to 8.3.4 (#494)

Bumps [mkdocs-material](https://github.com/squidfunk/mkdocs-material) from 8.3.2 to 8.3.4.
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](squidfunk/mkdocs-material@8.3.2...8.3.4)

---
updated-dependencies:
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump mkdocs-material from 8.3.4 to 8.3.6 (#498)

Bumps [mkdocs-material](https://github.com/squidfunk/mkdocs-material) from 8.3.4 to 8.3.6.
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](squidfunk/mkdocs-material@8.3.4...8.3.6)

---
updated-dependencies:
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* GH-490 Support encoding in `fileUpdate` hook (Fix #490) (#493)

* Bump com.coditory.integration-test from 1.4.0 to 1.4.2 (#508)

Bumps com.coditory.integration-test from 1.4.0 to 1.4.2.

---
updated-dependencies:
- dependency-name: com.coditory.integration-test
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump mkdocs-material from 8.3.6 to 8.3.9 (#504)

Bumps [mkdocs-material](https://github.com/squidfunk/mkdocs-material) from 8.3.6 to 8.3.9.
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](squidfunk/mkdocs-material@8.3.6...8.3.9)

---
updated-dependencies:
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump objenesis from 3.2 to 3.3 (#514)

Bumps [objenesis](https://github.com/easymock/objenesis) from 3.2 to 3.3.
- [Release notes](https://github.com/easymock/objenesis/releases)
- [Commits](easymock/objenesis@3.2...3.3)

---
updated-dependencies:
- dependency-name: org.objenesis:objenesis
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump mkdocs from 1.3.0 to 1.3.1 (#512)

Bumps [mkdocs](https://github.com/mkdocs/mkdocs) from 1.3.0 to 1.3.1.
- [Release notes](https://github.com/mkdocs/mkdocs/releases)
- [Commits](mkdocs/mkdocs@1.3.0...1.3.1)

---
updated-dependencies:
- dependency-name: mkdocs
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump org.jetbrains.kotlin.jvm from 1.4.0 to 1.7.10 (#507)

Bumps [org.jetbrains.kotlin.jvm](https://github.com/JetBrains/kotlin) from 1.4.0 to 1.7.10.
- [Release notes](https://github.com/JetBrains/kotlin/releases)
- [Changelog](https://github.com/JetBrains/kotlin/blob/v1.7.10/ChangeLog.md)
- [Commits](JetBrains/kotlin@v1.4.0...v1.7.10)

---
updated-dependencies:
- dependency-name: org.jetbrains.kotlin.jvm
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump sshd-git from 2.8.0 to 2.9.0 (#511)

Bumps [sshd-git](https://github.com/apache/mina-sshd) from 2.8.0 to 2.9.0.
- [Release notes](https://github.com/apache/mina-sshd/releases)
- [Changelog](https://github.com/apache/mina-sshd/blob/master/CHANGES.md)
- [Commits](apache/mina-sshd@sshd-2.8.0...sshd-2.9.0)

---
updated-dependencies:
- dependency-name: org.apache.sshd:sshd-git
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump sshd-core from 2.8.0 to 2.9.0 (#513)

Bumps [sshd-core](https://github.com/apache/mina-sshd) from 2.8.0 to 2.9.0.
- [Release notes](https://github.com/apache/mina-sshd/releases)
- [Changelog](https://github.com/apache/mina-sshd/blob/master/CHANGES.md)
- [Commits](apache/mina-sshd@sshd-2.8.0...sshd-2.9.0)

---
updated-dependencies:
- dependency-name: org.apache.sshd:sshd-core
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Co-authored-by: Chris Lee <chris@cloudshiftconsulting.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Artur Frysiak <artur@frysiak.net>
Co-authored-by: David <david0@users.noreply.github.com>
Co-authored-by: Dzikoysk <dzikoysk@dzikoysk.net>
  • Loading branch information
6 people authored Aug 3, 2022
1 parent eb50889 commit 6e58b05
Show file tree
Hide file tree
Showing 95 changed files with 1,135 additions and 1,977 deletions.
8 changes: 4 additions & 4 deletions docs/configuration/authorization.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,15 @@ from or key in form of String.

scmVersion {
repository {
customKey = project.file('keys/my_secret_key')
customKeyFile.set(project.file('keys/my_secret_key'))
}
}


task loadKeyPassword << {
scmVersion.repository.customKeyPassword = loadPasswordFromSecureStorageOrSomething()
scmVersion.repository.customKeyPassword.set( loadPasswordFromSecureStorageOrSomething())
// you can load the key from secure storage as well!
scmVersion.repository.customKey = loadKeyFromSecureStorageOrSomething()
scmVersion.repository.customKey.set( loadKeyFromSecureStorageOrSomething())
}

task release {
Expand All @@ -70,5 +70,5 @@ made via `scmVersion.repository.customUsername` and
`scmVersion.repository.customPassword` properties:

task loadGitHubToken << {
scmVersion.repository.customUsername = loadGitHubTokenFromSomewhere()
scmVersion.repository.customUsername.set(loadGitHubTokenFromSomewhere())
}
10 changes: 5 additions & 5 deletions docs/configuration/basic_usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ apply plugin: 'pl.allegro.tech.build.axion-release'
```
scmVersion {
tag {
prefix = 'my-project-name'
prefix.set("my-project-name")
}
}
Expand Down Expand Up @@ -117,25 +117,25 @@ my-service
my-service-client
```

Use the `projectDirs` configuration parameter within a `monorepos` block to identify submodules
Use the `exclude()` configuration parameter within a `monorepos` block to identify submodules
that should be excluded from consideration when calculating whether to increment
the version of the parent project. Typically, you would do this in the top level
project, assuming that submodules are named after the directory they appear in:

```
scmVersion {
monorepos {
projectDirs = project.subprojects.collect({p -> p.name})
exclude(project.subprojects.collect({p -> p.name}))
}
}
```

Version calculation rules:
1. Changes to files within a submodule increment that submodule's version only.
2. Changes to a submodule do not cause a change to the parent project's version if
the parent is set to ignore that submodule, via `projectDirs`.
the parent is set to ignore that submodule, via `exclude()`.
3. Changes to files in the parent project but which are not in a submodule identified via
`projectDirs` will cause the parent project's version to increment but not the
`exclude()` will cause the parent project's version to increment but not the
versions of any submodules. If this is desired then consider wiring the `createRelease` or
`release` tasks of the submodules to be dependencies of the tasks of the same name in the parent.

Expand Down
6 changes: 3 additions & 3 deletions docs/configuration/checks.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ using `scmVersion.checks` properties:

scmVersion {
checks {
uncommittedChanges = false
aheadOfRemote = false
snapshotDependencies = false
uncommittedChanges.set(false)
aheadOfRemote.set(false)
snapshotDependencies.set(false)
}
}

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/dry_run.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Local only mode can be switch on either using command line flag:
or by altering configuration:

scmVersion {
localOnly = true
localOnly.set(true)
}

Flag has precedence over configuration. Local only mode is evaluated
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ will print additional message:
import pl.allegro.tech.build.axion.release.OutputCurrentVersionTask

task customTask(type: OutputCurrentVersionTask) {
versionConfig = new VersionConfig(project)
versionConfig = project.objects.newInstance(VersionConfig,project.rootProject.layout.projectDirectory)
}

customTask.doFirst {
Expand Down
8 changes: 4 additions & 4 deletions docs/configuration/next_version.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ using `scmVersion.nextVersion.suffix` and

scmVersion {
nextVersion {
suffix = 'alpha'
separator = '-'
suffix.set("alpha")
separator.set("-")
}
}

Expand All @@ -56,7 +56,7 @@ documentation to see what serializers and deserializers are:

scmVersion {
nextVersion {
serializer = { nextVersionConfig, version -> ...}
deserializer = { nextVersionConfig, position -> ...}
serializer( { nextVersionConfig, version -> ...})
deserializer( { nextVersionConfig, position -> ...})
}
}
78 changes: 38 additions & 40 deletions docs/configuration/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,73 +7,71 @@ All `axion-release-plugin` configuration options:

repository {
// doc: Repository
type = 'git' // type of repository
directory = project.rootProject.file('./') // repository location
remote = 'origin' // remote name
type.set("git") // type of repository
directory.set(project.rootProject.file("./")) // repository location
remote.set("origin") // remote name

// doc: Authorization
customKey = 'AAasaDDSSD...' or project.file('myKey') // custom authorization key (file or String)
customKeyPassword = 'secret' // key password
customKey.set("AAasaDDSSD...") // custom authorization key
customKeyFile.set(project.file("myKey")) // custom authorization key (from file)
customKeyPassword.set("secret") // key password
}

// doc: Dry run
localOnly = false // never connect to remote
localOnly.set(false) // never connect to remote

// doc: Uncommitted changes
ignoreUncommittedChanges = true // should uncommitted changes force version bump
ignoreUncommittedChanges.set(true) // should uncommitted changes force version bump

// doc: Version / Tag with highest version
useHighestVersion = false // Defaults as false, setting to true will find the highest visible version in the commit tree
useHighestVersion.set(false) // Defaults as false, setting to true will find the highest visible version in the commit tree

// doc: Version / Sanitization
sanitizeVersion = true // should created version be sanitized, true by default

// doc: Basic usage / Basic configuration
foldersToExclude = ['submodule1', 'submodule2'] // ignore changes in these subdirs when calculating changes to parent
sanitizeVersion.set(true) // should created version be sanitized, true by default

tag { // doc: Version / Parsing
prefix = 'tag-prefix' // prefix to be used, 'v' by default, empty String means no prefix
branchPrefix = [ // set different prefix per branch
'legacy/.*' : 'legacy'
]

versionSeparator = '-' // separator between prefix and version number, '' by default, empty String means no separator
serialize = { tag, version -> ... } // creates tag name from raw version
deserialize = { tag, position, tagName -> ... } // reads raw version from tag
initialVersion = { tag, position -> ... } // returns initial version if none found, 0.1.0 by default
prefix.set("tag-prefix") // prefix to be used, "v" by default, empty String means no prefix
branchPrefix.putAll( [ // set different prefix per branch
"legacy/.*" : "legacy"
])

versionSeparator.set("-") // separator between prefix and version number, "" by default, empty String means no separator
serialize({ tag, version -> ... }) // creates tag name from raw version
deserialize( { tag, position, tagName -> ... }) // reads raw version from tag
initialVersion({ tag, position -> ... }) // returns initial version if none found, 0.1.0 by default
}

nextVersion { // doc: Next version markers
suffix = 'alpha' // tag suffix
separator = '-' // separator between version and suffix
serializer = { nextVersionConfig, version -> ... } // append suffix to version tag
deserializer = { nextVersionConfig, position -> ... } // strip suffix off version tag
suffix.set("alpha") // tag suffix
separator.set("-") // separator between version and suffix
serializer({ nextVersionConfig, version -> ... }) // append suffix to version tag
deserializer({ nextVersionConfig, position -> ... }) // strip suffix off version tag
}

// doc: Version / Decorating
versionCreator { version, position -> ... } // creates version visible for Gradle from raw version and current position in scm
versionCreator 'versionWithBranch' // use one of predefined version creators
branchVersionCreator = [ // use different creator per branch
'feature/.*': 'default'
]
versionCreator({ version, position -> ... }) // creates version visible for Gradle from raw version and current position in scm
versionCreator("versionWithBranch") // use one of predefined version creators
branchVersionCreator.putAll( [ // use different creator per branch
"feature/.*": "default"
])

// doc: Version / Snapshot
snapshotCreator { version, position -> ... } // customize 'snapshot' suffix for version not on tag
snapshotCreator({ version, position -> ... }) // customize "snapshot" suffix for version not on tag

// doc: Version / Incrementing
versionIncrementer {context, config -> ...} // closure that increments a version from the raw version, current position in scm and config
versionIncrementer 'incrementPatch' // use one of predefined version incrementing rules
branchVersionIncrementer = [ // use different incrementer per branch
'feature/.*': 'incrementMinor'
]
versionIncrementer({context, config -> ...}) // closure that increments a version from the raw version, current position in scm and config
versionIncrementer("incrementPatch") // use one of predefined version incrementing rules
branchVersionIncrementer.putAll( [ // use different incrementer per branch
"feature/.*": "incrementMinor"
])

// doc: Pre/post release hooks
createReleaseCommit true // should create empty commit to annotate release in commit history, false by default
releaseCommitMessage { version, position -> ... } // custom commit message if commits are created
createReleaseCommit.set(true) // should create empty commit to annotate release in commit history, false by default
releaseCommitMessage({ version, position -> ... }) // custom commit message if commits are created

// doc: Pre-release checks
checks {
uncommittedChanges = false // permanently disable uncommitted changes check
aheadOfRemote = false // permanently disable ahead of remote check
uncommittedChanges.set(false) // permanently disable uncommitted changes check
aheadOfRemote.set(false) // permanently disable ahead of remote check
}
}
6 changes: 3 additions & 3 deletions docs/configuration/repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ property:

scmVersion {
repository {
directory = project.rootProject.file('../')
directory.set(project.rootProject.file('../'))
}
}

You can also change remote used to push changes:

scmVersion {
repository {
remote = 'myRemote'
remote.set("myRemote")
}
}

Expand All @@ -32,7 +32,7 @@ allowed even when a local branch is not checked out:

scmVersion {
repository {
pushTagsOnly = true
pushTagsOnly.set(true)
}
}

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/uncommitted_changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ In order to treat uncommitted changes as trigger for version increment,
change setting:

scmVersion {
ignoreUncommittedChanges = false
ignoreUncommittedChanges.set(false)
}

This changes behavior from:
Expand Down
Loading

0 comments on commit 6e58b05

Please sign in to comment.