Interface ConventionalVersionExtension

public interface ConventionalVersionExtension
Configuration, in the settings file.

Every option is named after its release-please counterpart and carries release-please's default, so the two configurations can be compared by eye and a divergence is greppable.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.gradle.api.provider.Property<Boolean>
    getBumpMinorPreMajor()
    Below 1.0.0, treat a breaking change as a minor bump instead of a major one.
    org.gradle.api.provider.Property<Boolean>
    getBumpPatchForMinorPreMajor()
    Below 1.0.0, treat a feature as a patch bump instead of a minor one.
    org.gradle.api.provider.Property<String>
    getInitialVersion()
    The version a project that has never released starts at.
    org.gradle.api.provider.Property<String>
    getTagPrefix()
    Prefix on release tags.

  • Method Details

    • getInitialVersion

      org.gradle.api.provider.Property<String> getInitialVersion()
      The version a project that has never released starts at. release-please initial-version; defaults to 1.0.0, which is what release-please actually cuts for a first release.

    • getTagPrefix

      org.gradle.api.provider.Property<String> getTagPrefix()
      Prefix on release tags. release-please tag-prefix; defaults to v.

    • getBumpMinorPreMajor

      org.gradle.api.provider.Property<Boolean> getBumpMinorPreMajor()
      Below 1.0.0, treat a breaking change as a minor bump instead of a major one. release-please bump-minor-pre-major; defaults to false. No effect once the major is non-zero.

    • getBumpPatchForMinorPreMajor

      org.gradle.api.provider.Property<Boolean> getBumpPatchForMinorPreMajor()
      Below 1.0.0, treat a feature as a patch bump instead of a minor one. release-please bump-patch-for-minor-pre-major; defaults to false. No effect once the major is non-zero.