releaseOnlyOnReleaseBranches & releaseBranchNames options

docs/configuration/overview.md

@@ -73,6 +73,10 @@ All `axion-release-plugin` configuration options:
  uncommittedChanges.set(false) // permanently disable uncommitted changes check
  aheadOfRemote.set(false) // permanently disable ahead of remote check
  }
+
+ // doc: Version / releaseOnlyOnReleaseBranches
+ releaseOnlyOnReleaseBranches = false
+ releaseBranchNames = ['master', 'main']
  }
 
 All `axion-release-plugin` configuration flags:
@@ -108,3 +112,9 @@ All `axion-release-plugin` configuration flags:
 - release.fetchTags
  - default: false
  - fetch tags from the remote repository
+- release.releaseOnlyOnReleaseBranches
+ - default: false
+ - only perform a release on branches that match the `releaseBranchNames`
+- release.releaseBranchNames
+ - default: `['master', 'main']`
+ - a list of branch names that are considered release branches

docs/configuration/version.md

@@ -278,6 +278,30 @@ This rule uses additional parameter `initialPreReleaseIfNotOnPrerelease`
  versionIncrementer('incrementPrerelease', [initialPreReleaseIfNotOnPrerelease: 'rc1'])
  }
 
+### releaseOnlyOnReleaseBranches
+
+You can set this flag to true to prevent releasing on branches that are
+not marked as release branches. By default, this flag is set to false.
+
+ scmVersion {
+ releaseOnlyOnReleaseBranches = true
+ }
+
+This flag can also be set via command line:
+
+ ./gradlew release -Prelease.releaseOnlyOnReleaseBranches
+
+And works well in combination with `releaseBranchNames` option
+
+ scmVersion {
+ releaseOnlyOnReleaseBranches = true
+ releaseBranchNames = ['main', 'master']
+ }
+
+or as command line
+
+ ./gradlew release -Prelease.releaseOnlyOnReleaseBranches -Prelease.releaseBranchNames=main,release
+
 ## Decorating
 
 Decorating phase happens only when version is read (and deserialized).
@@ -367,9 +391,7 @@ Custom version creators can be implemented by creating closure:
  {version, position -> ...}
 
 - version - string version resolved by previous steps
--
-position - [ScmPosition](https:/allegro/axion-release-plugin/blob/main/src/main/java/pl/allegro/tech/build/axion/release/domain/scm/ScmPosition.java)
-object
+- position - [ScmPosition](https:/allegro/axion-release-plugin/blob/main/src/main/java/pl/allegro/tech/build/axion/release/domain/scm/ScmPosition.java) object
 
 ### Snapshot
 
@@ -386,9 +408,7 @@ Snapshot creator can be implemented by creating closure:
  {version, position -> ...}
 
 - version - string version resolved by previous steps
--
-position - [ScmPosition](https:/allegro/axion-release-plugin/blob/main/src/main/java/pl/allegro/tech/build/axion/release/domain/scm/ScmPosition.java)
-object
+- position - [ScmPosition](https:/allegro/axion-release-plugin/blob/main/src/main/java/pl/allegro/tech/build/axion/release/domain/scm/ScmPosition.java) object
 
 ## Sanitization
 

src/integration/groovy/pl/allegro/tech/build/axion/release/SimpleIntegrationTest.groovy

@@ -140,4 +140,49 @@ class SimpleIntegrationTest extends BaseIntegrationTest {
  result.output.contains('Project version: 0.0.1-SNAPSHOT')
  result.task(":currentVersion").outcome == TaskOutcome.SUCCESS
  }
+
+ def "should skip release when releaseOnlyOnReleaseBranches is true and current branch is not on releaseBranchNames list"() {
+ given:
+ buildFile("""
+ scmVersion {
+ releaseOnlyOnReleaseBranches = true
+ releaseBranchNames = ['develop', 'release']
+ }
+ """)
+
+ when:
+ def releaseResult = runGradle('release', '-Prelease.version=1.0.0', '-Prelease.localOnly', '-Prelease.disableChecks')
+
+ then:
+ releaseResult.task(':release').outcome == TaskOutcome.SUCCESS
+ releaseResult.output.contains('Release step skipped since \'releaseOnlyOnDefaultBranches\' option is set, and \'master\' was not in \'releaseBranchNames\' list [develop, release]')
+ }
+
+ def "should skip release when releaseOnlyOnReleaseBranches is set by gradle task property and current branch is not on releaseBranchNames list"() {
+ given:
+ buildFile("")
+
+ when:
+ def releaseResult = runGradle('release', '-Prelease.releaseOnlyOnReleaseBranches', '-Prelease.releaseBranchNames=develop,release', '-Prelease.version=1.0.0', '-Prelease.localOnly', '-Prelease.disableChecks')
+
+ then:
+ releaseResult.task(':release').outcome == TaskOutcome.SUCCESS
+ releaseResult.output.contains('Release step skipped since \'releaseOnlyOnDefaultBranches\' option is set, and \'master\' was not in \'releaseBranchNames\' list [develop, release]')
+ }
+
+ def "should not skip release when releaseOnlyOnReleaseBranches is true when on master branch (default releaseBranches list)"() {
+ given:
+ buildFile("""
+ scmVersion {
+ releaseOnlyOnReleaseBranches = true
+ }
+ """)
+
+ when:
+ def releaseResult = runGradle('release', '-Prelease.version=1.0.0', '-Prelease.localOnly', '-Prelease.disableChecks')
+
+ then:
+ releaseResult.task(':release').outcome == TaskOutcome.SUCCESS
+ releaseResult.output.contains('Creating tag: ' + fullPrefix() + '1.0.0')
+ }
 }

src/main/groovy/pl/allegro/tech/build/axion/release/ReleaseTask.groovy

@@ -3,6 +3,7 @@ package pl.allegro.tech.build.axion.release
 import org.gradle.api.tasks.TaskAction
 import pl.allegro.tech.build.axion.release.domain.Releaser
 import pl.allegro.tech.build.axion.release.domain.scm.ScmPushResult
+import pl.allegro.tech.build.axion.release.domain.scm.ScmService
 import pl.allegro.tech.build.axion.release.infrastructure.di.VersionResolutionContext
 
 import java.nio.file.Files
@@ -15,10 +16,21 @@ abstract class ReleaseTask extends BaseAxionTask {
  void release() {
  VersionResolutionContext context = resolutionContext()
  Releaser releaser = context.releaser()
+ ScmService scmService = context.scmService()
+
+ if (scmService.isReleaseOnlyOnDefaultBranches()) {
+ def releaseBranchNames = scmService.getReleaseBranchNames()
+ def currentBranch = context.repository().currentPosition().getBranch()
+ if (!releaseBranchNames.contains(currentBranch)) {
+ logger.quiet("Release step skipped since 'releaseOnlyOnDefaultBranches' option is set, and '${currentBranch}' was not in 'releaseBranchNames' list [${releaseBranchNames.join(', ')}]")
+ return
+ }
+ }
+
  ScmPushResult result = releaser.releaseAndPush(context.rules())
 
  if (!result.success) {
- def status = result.failureStatus.orElse("Unknown status of push")
+ def status = result.failureStatus
  def message = result.remoteMessage.orElse("Unknown error during push")
  logger.error("remote status: ${status}")
  logger.error("remote message: ${message}")

src/main/groovy/pl/allegro/tech/build/axion/release/domain/BaseExtension.groovy

@@ -28,11 +28,15 @@ abstract class BaseExtension {
  GradleVersion.current()
  }
 
+ protected Provider<Set<String>> gradleSetProperty(String name) {
+ return gradleProperty(name).map({ it.tokenize(',') as Set })
+ }
+
  protected Provider<Boolean> gradlePropertyBoolean(String name) {
  return gradleProperty(name).map(Boolean::valueOf)
  }
 
  protected Provider<Boolean> gradlePropertyPresent(String name) {
- return gradleProperty(name).map({true})
+ return gradleProperty(name).map({ true })
  }
 }

src/main/groovy/pl/allegro/tech/build/axion/release/domain/VersionConfig.groovy

@@ -6,6 +6,7 @@ import org.gradle.api.file.Directory
 import org.gradle.api.provider.MapProperty
 import org.gradle.api.provider.Property
 import org.gradle.api.provider.Provider
+import org.gradle.api.provider.SetProperty
 import org.gradle.api.tasks.Input
 import org.gradle.api.tasks.Internal
 import org.gradle.api.tasks.Nested
@@ -33,6 +34,8 @@ abstract class VersionConfig extends BaseExtension {
  private static final String DEPRECATED_FORCE_VERSION_PROPERTY = 'release.forceVersion'
  private static final String VERSION_INCREMENTER_PROPERTY = 'release.versionIncrementer'
  private static final String VERSION_CREATOR_PROPERTY = 'release.versionCreator'
+ private static final String RELEASE_ONLY_ON_RELEASE_BRANCHES_PROPERTY = 'release.releaseOnlyOnReleaseBranches'
+ private static final String RELEASE_BRANCH_NAMES_PROPERTY = 'release.releaseBranchNames'
 
  @Inject
  VersionConfig(Directory repositoryDirectory) {
@@ -41,6 +44,8 @@ abstract class VersionConfig extends BaseExtension {
  getIgnoreUncommittedChanges().convention(true)
  getUseHighestVersion().convention(false)
  getUnshallowRepoOnCI().convention(false)
+ getReleaseBranchNames().convention(gradleSetProperty(RELEASE_BRANCH_NAMES_PROPERTY).orElse(['master', 'main'] as Set))
+ getReleaseOnlyOnReleaseBranches().convention(gradlePropertyPresent(RELEASE_ONLY_ON_RELEASE_BRANCHES_PROPERTY).orElse(false))
  getReleaseBranchPattern().convention(Pattern.compile('^' + defaultPrefix() + '(/.*)?$'))
  getSanitizeVersion().convention(true)
  getCreateReleaseCommit().convention(false)
@@ -79,7 +84,10 @@ abstract class VersionConfig extends BaseExtension {
  abstract Property<Boolean> getIgnoreUncommittedChanges()
 
  @Internal
- abstract Property<Boolean> getUseHighestVersion();
+ abstract SetProperty<String> getReleaseBranchNames()
+
+ @Internal
+ abstract Property<Boolean> getReleaseOnlyOnReleaseBranches()
 
  @Internal
  @Incubating
@@ -112,6 +120,9 @@ abstract class VersionConfig extends BaseExtension {
  @Internal
  abstract Property<PredefinedReleaseCommitMessageCreator.CommitMessageCreator> getReleaseCommitMessage()
 
+ @Internal
+ abstract Property<Boolean> getUseHighestVersion();
+
  Provider<Boolean> ignoreUncommittedChanges() {
  gradlePropertyPresent(IGNORE_UNCOMMITTED_CHANGES_PROPERTY)
  .orElse(ignoreUncommittedChanges)
@@ -132,8 +143,8 @@ abstract class VersionConfig extends BaseExtension {
  Provider<String> forcedVersion() {
  gradleProperty(FORCE_VERSION_PROPERTY)
  .orElse(gradleProperty(DEPRECATED_FORCE_VERSION_PROPERTY))
- .map({it.trim()})
- .map({ it.isBlank() ? null : it})
+  .map({ it.trim() })
+  .map({ it.isBlank() ? null : it })
  }
 
  Provider<String> versionIncrementerType() {
@@ -216,12 +227,12 @@ abstract class VersionConfig extends BaseExtension {
 
  Provider<VersionService.DecoratedVersion> versionProvider() {
  def cachedVersionSupplier = this.cachedVersionSupplier
- providers.provider( { cachedVersionSupplier.resolve(this,layout.projectDirectory)})
+ providers.provider({ cachedVersionSupplier.resolve(this, layout.projectDirectory) })
  }
 
  Provider<VersionService.DecoratedVersion> uncachedVersionProvider() {
  def versionSupplier = this.versionSupplier
- providers.provider( { versionSupplier.resolve(this, layout.projectDirectory)})
+ providers.provider({ versionSupplier.resolve(this, layout.projectDirectory) })
  }
 
  @Nested
@@ -231,21 +242,21 @@ abstract class VersionConfig extends BaseExtension {
 
  @Input
  String getVersion() {
- return versionProvider().map({ it.decoratedVersion}).get()
+ return versionProvider().map({ it.decoratedVersion }).get()
  }
 
  @Input
  String getPreviousVersion() {
- return versionProvider().map({ it.previousVersion}).get()
+ return versionProvider().map({ it.previousVersion }).get()
  }
 
  @Input
  String getUndecoratedVersion() {
- return versionProvider().map({ it.undecoratedVersion}).get()
+ return versionProvider().map({ it.undecoratedVersion }).get()
  }
 
  @Nested
  ScmPosition getScmPosition() {
- return versionProvider().map({it.position}).get()
+ return versionProvider().map({ it.position }).get()
  }
 }

src/main/groovy/pl/allegro/tech/build/axion/release/infrastructure/config/ScmPropertiesFactory.groovy

@@ -17,7 +17,9 @@ class ScmPropertiesFactory {
  config.repository.overriddenBranch().getOrNull(),
  config.repository.overriddenIsClean().getOrNull(),
  ScmIdentityFactory.create(config.repository, config.repository.disableSshAgent().get()),
- config.getUnshallowRepoOnCI().get()
+ config.getUnshallowRepoOnCI().get(),
+ config.getReleaseBranchNames().get(),
+ config.getReleaseOnlyOnReleaseBranches().get()
  )
  }
 }

src/main/java/pl/allegro/tech/build/axion/release/domain/scm/ScmProperties.java

@@ -2,6 +2,7 @@
 
 import java.io.File;
 import java.util.Optional;
+import java.util.Set;
 
 public class ScmProperties {
 
@@ -16,6 +17,8 @@ public class ScmProperties {
  private final Boolean overriddenIsClean;
  private final ScmIdentity identity;
  private final Boolean unshallowRepoOnCI;
+ private final Set<String> releaseBranchNames;
+ private final boolean releaseOnlyOnReleaseBranches;
 
  public ScmProperties(
  String type,
@@ -28,7 +31,9 @@ public ScmProperties(
  String overriddenBranchName,
  Boolean overriddenIsClean,
  ScmIdentity identity,
- Boolean unshallowRepoOnCI
+ Boolean unshallowRepoOnCI,
+ Set<String> releaseBranchNames,
+ boolean releaseOnlyOnReleaseBranches
  ) {
  this.type = type;
  this.directory = directory;
@@ -41,6 +46,8 @@ public ScmProperties(
  this.overriddenIsClean = overriddenIsClean;
  this.identity = identity;
  this.unshallowRepoOnCI = unshallowRepoOnCI;
+ this.releaseBranchNames = releaseBranchNames;
+ this.releaseOnlyOnReleaseBranches = releaseOnlyOnReleaseBranches;
  }
 
  public ScmPushOptions pushOptions() {
@@ -90,4 +97,12 @@ public final ScmIdentity getIdentity() {
  public Boolean isUnshallowRepoOnCI() {
  return unshallowRepoOnCI;
  }
+
+ public Set<String> getReleaseBranchNames() {
+ return releaseBranchNames;
+ }
+
+ public boolean isReleaseOnlyOnReleaseBranches() {
+ return releaseOnlyOnReleaseBranches;
+ }
 }

src/main/java/pl/allegro/tech/build/axion/release/domain/scm/ScmService.java

@@ -7,6 +7,7 @@
 
 import java.util.List;
 import java.util.Optional;
+import java.util.Set;
 
 public class ScmService {
  private static final Logger logger = Logging.getLogger(ScmService.class);
@@ -69,4 +70,12 @@ public List<String> lastLogMessages(int messageCount) {
  public boolean isLegacyDefTagnameRepo() {
  return repository.isLegacyDefTagnameRepo();
  }
+
+ public Set<String> getReleaseBranchNames() {
+ return scmProperties.getReleaseBranchNames();
+ }
+
+ public boolean isReleaseOnlyOnDefaultBranches(){
+ return scmProperties.isReleaseOnlyOnReleaseBranches();
+ }
 }