Field Detail

• public static final java.lang.String GRADLE_PROPERTIES

  Default file name of gradle.properties.

Property Detail

• java.util.Map _packageInfo

  Package information extracted from gradle settings.

• java.lang.Object steps

  Reference to the groovy pipeline variable.

• java.lang.String versionDefinitionFile

  File name which defined package version.

  Default:

  GRADLE_PROPERTIES.

Constructor Detail

• Gradle(java.lang.Object steps)

  Constructs the class.

  When invoking from a Jenkins pipeline script, the Pipeline must be passed the current environment of the Jenkinsfile to have access to the steps.

  Example:

   def gradle = new Gradle(this)
   

  Parameters:

  steps - The workflow steps object provided by the Jenkins pipeline

Method Detail

• java.lang.Boolean _isVersionDefinedInGradleProperties()

  This checks if version entry is defined in versionDefinitionFile.

  Note:

  This is pre-req to perform a gradle release (bump version).

  Note:

  this method doesn't throw exception if the version is not defined in versionDefinitionFile.

  Returns:

  true/false

• void _updateVersion(java.lang.String version)

  Update version in versionDefinitionFile.

  Parameters:

  version - new semantic version string. For example, "1.2.3".

• void bootstrap()

  Bootstrap gradle.

  Usually the bootstrap is for downloading gradle/wrapper/gradle-wrapper.jar to local, so we don't need to upload the gradle-wrapper.jar into GitHub repository.

• void clearPackageInfoCache()

  Reset package info cache

• java.util.Map getPackageInfo()

  Get current package information from gradle settings.

  Note:

  This method has cache. If you need to reload package info from gradle settings, run method clearPackageInfoCache() to reset the cache.

  Expected keys in the result Map:

  • name - name of the package. For example, "explorer-jobs".
  • version - version of the package. For example, "1.2.3".
  • versionTrunks - Map version trunks returned from Utils.parseSemanticVersion.
  • group - group name of the package if defined. For example, "org.zowe.explorer.jobs".
  • description - description of the package if defined. For example, "An API to handle z/OS jobs.".
  • scripts - List of tasks of the package defined. For example, ["build", "buildDir", "class", "assemble", "release", ...].

  Returns:

  current package information including name, version, description, license, etc

• void init(java.util.Map args = [:])

  Initialize gradle project properties.

  Note:

  The below parameters are supported keys of the args Map.

  Parameters:

  versionDefinitionFile - file where defines version of the project.

• void version(java.util.Map args = [:])

  Declare a new version of gradle project.

  Note:

  This task will bump the package version on gradle settings, commit the change, and push to GitHub. The commit is signed-off.

  Example:

       def github = new org.zowe.jenkins_shared_library.scm.GitHub(this)
       // bump patch version on master branch
       gradle.version(
           github  :     github,
           branch  :     'master',
           version :     'patch'
       )
       // After this, you should be able to see your repository master branch has a commit of
       // version bump.
   

  Note:

  Use similar parameters defined in init(Map) method and with these extra parameters:

  See Also:

  GitHub

  Parameters:

  github - GitHub instance must have been initialized with repository, credential, etc

  branch - which branch to perform the release

  version - what kind of version bump we should make

• void version(org.zowe.jenkins_shared_library.scm.GitHub github, java.lang.String branch, java.lang.String version = 'PATCH')

  Declare a new version of gradle project

  See Also:

  version(Map)