Merge pull request #61 from wcm-io-devops/feature/release-2.0.0

prepare release 2.0.0

Author: Tobias Richter

README.md

@@ -113,7 +113,6 @@ The pipeline library comes with the following steps:
     *  [`lookupHttpCredential`](vars/credentials.md#lookuphttpcredentialstring-uri)
     *  [`lookupScmCredential`](vars/credentials.md#lookupscmcredentialstring-uri)
     *  [`lookupSshCredential`](vars/credentials.md#lookupsshcredentialstring-uri)
-* [`execManagedShellScript`](vars/execManagedShellScript.md)
 * [`execMaven`](vars/execMaven.md)
 * [`execMavenRelease`](vars/execMavenRelease.md)
 * [`execNpm`](vars/execNpm.md)
@@ -142,16 +141,11 @@ The pipeline library comes with the following steps:
   * [`notify.mattermost`](vars/notify.md#notifymattermostmap-config)
   * [`notify.mqtt`](vars/notify.md#notifymqttmap-config)
   * [`notify.teams`](vars/notify.md#notifyteamsmap-config)
-* [`notifyMail`](vars/notifyMail.md) :warning: deprecated, use
-  [`notify.mail`](vars/notify.md#notifymailmap-config) instead
 * [`setBuildName`](vars/setBuildName.md)
-* [`setGitBranch`](vars/setGitBranch.md)
 * [`setScmUrl`](vars/setScmUrl.md)
 * [`setupTools`](vars/setupTools.md)
 * [`sshAgentWrapper`](vars/sshAgentWrapper.md)
 * [`transferScp`](vars/transferScp.md)
-* [wrap](vars/wrap.md)
-    * [`wrap.color`](vars/wrap.md) :warning: deprecated, use [`wrappers`](vars/wrappers.md) instead.
 * [wrappers](vars/wrappers.md)
     * [`wrappers.color`](vars/wrappers.md#colormap-config-closure-body)
 

assembly/complete.xml

@@ -13,6 +13,7 @@
         <include>resources/**/*</include>
         <include>src/**/*</include>
         <include>vars/**/*</include>
+        <include>test/**/*</include>
         <include>**/*.md</include>
       </includes>
     </fileSet>

docs/config-structure.md

@@ -69,7 +69,7 @@ Map config = [
 ]
 
 // initialize the logger
-Logger.init(steps, config)
+Logger.init(this, config)
 
 node() {
     // setup the tools

docs/usage-examples.md

@@ -26,7 +26,7 @@ Map config = [
 // surround by try and catch
 try {
     // initialize the logger
-    Logger.init(steps, config)
+    Logger.init(this, config)
     node() {
         // setup the tools
         setupTools(config)

jenkinsfiles/integration-tests.groovy

@@ -202,10 +202,6 @@ node() {
       log.info(ManagedFileConstants.MAVEN_SETTING_ENV, ManagedFileConstants.MAVEN_SETTING_ENV)
       log.info(ManagedFileConstants.NPM_CONFIG_USERCONFIG_PATH, ManagedFileConstants.NPM_CONFIG_USERCONFIG_PATH)
       log.info(ManagedFileConstants.NPM_CONFIG_USERCONFIG_ENV, ManagedFileConstants.NPM_CONFIG_USERCONFIG_ENV)
-      log.info(ManagedFileConstants.NPM_CONF_USERCONFIG_ENV, ManagedFileConstants.NPM_CONF_USERCONFIG_ENV)
-      log.info(ManagedFileConstants.NPMRC_PATH, ManagedFileConstants.NPMRC_PATH)
-      log.info(ManagedFileConstants.NPMRC_ENV, ManagedFileConstants.NPMRC_ENV)
-      log.info(ManagedFileConstants.NPM_CONF_GLOBALCONFIG_ENV, ManagedFileConstants.NPM_CONF_GLOBALCONFIG_ENV)
       log.info(ManagedFileConstants.BUNDLE_CONFIG_ENV, ManagedFileConstants.BUNDLE_CONFIG_ENV)
       log.info(ManagedFileConstants.BUNDLE_CONFIG_PATH, ManagedFileConstants.BUNDLE_CONFIG_PATH)
 
@@ -350,8 +346,6 @@ node() {
       mavenCommandBuilder.build()
       mavenCommandBuilder.reset()
 
-      mavenCommandBuilder = new MavenCommandBuilderImpl((DSL) this.steps, "mvn")
-
       mavenCommandBuilder = new MavenCommandBuilderImpl((DSL) this.steps, [:])
       mavenCommandBuilder = new MavenCommandBuilderImpl((DSL) this.steps, [:], "mvn")
     }
@@ -426,9 +420,6 @@ node() {
     integrationTestUtils.runTest("Logger") {
       Logger test = new Logger(this)
       // call all logger init functions
-      Logger.init((DSL) this.steps, [:])
-      Logger.init((DSL) this.steps, "info")
-      Logger.init((DSL) this.steps, 0)
       Logger.init(this, [:])
       Logger.init(this, "info")
       Logger.init(this, 0)

pom.xml

@@ -29,7 +29,7 @@
 
   <groupId>io.wcm.devops.jenkins</groupId>
   <artifactId>io.wcm.devops.jenkins.pipeline-library</artifactId>
-  <version>1.9.1-SNAPSHOT</version>
+  <version>2.0.0-SNAPSHOT</version>
   <description>wcm.io Jenkins Pipeline Library</description>
 
   <scm>

src/io/wcm/devops/jenkins/pipeline/managedfiles/ManagedFileConstants.groovy

@@ -35,19 +35,7 @@ class ManagedFileConstants implements Serializable {
   static final String MAVEN_SETTING_ENV = "MVN_SETTINGS"
 
   static final String NPM_CONFIG_USERCONFIG_PATH = "managedfiles/npm/npm-config-userconfig.json"
-  // wrong named in existing jenkins/maven projects
-  @Deprecated
   static final String NPM_CONFIG_USERCONFIG_ENV = "NPM_CONFIG_USERCONFIG"
-  // correct name based on NPM config
-  static final String NPM_CONF_USERCONFIG_ENV = "NPM_CONF_USERCONFIG"
-
-  static final String NPMRC_PATH = "managedfiles/npm/npmrc.json"
-  // wrong name in existing jenkins/maven projects
-  @Deprecated
-  static final String NPMRC_ENV = "NPMRC"
-  // correct name based on NPM config
-  static final String NPM_CONF_GLOBALCONFIG_ENV = "NPM_CONF_GLOBALCONFIG"
-
 
   static final String BUNDLE_CONFIG_ENV = "BUNDLE_CONFIG"
   static final String BUNDLE_CONFIG_PATH = "managedfiles/ruby/bundle-config.json"

src/io/wcm/devops/jenkins/pipeline/shell/MavenCommandBuilderImpl.groovy

@@ -49,22 +49,11 @@ class MavenCommandBuilderImpl implements Serializable, CommandBuilder, ConfigAwa
 
   public Logger log = new Logger(this)
 
-  /**
-   * @param dsl The DSL object of the current pipeline script (available via this.steps in pipeline scripts)
-   * @param executable The executable, default: 'maven'
-   *
-   * @deprecated
-   */
-  MavenCommandBuilderImpl(DSL dsl, String executable = null) {
-    this(dsl, [:], executable)
-    log.warn("Calling MavenCommandBuilderImpl Constructor without params is deprecated and is subject to remove in the upcoming versions")
-  }
-
   /**
    * @param dsl The DSL object of the current pipeline script (available via this.steps in pipeline scripts)
    * @param executable The executable, default: 'maven'
    */
-  MavenCommandBuilderImpl(DSL dsl, Map params, String executable = null) {
+  MavenCommandBuilderImpl(DSL dsl, Map params = [:], String executable = null) {
     commandBuilder = new CommandBuilderImpl(dsl, executable ?: EXECUTABLE)
     this.dsl = dsl
     this._params = params

src/io/wcm/devops/jenkins/pipeline/utils/logging/Logger.groovy

@@ -80,7 +80,7 @@ class Logger implements Serializable {
    *
    * @param dsl The DSL object of the current pipeline script (available via this.steps in pipeline scripts)
    * @param logLvl The log level to use during execution of the pipeline script
-   * @deprecated
+   * @deprecated still used by tests
    */
   @NonCPS
   static void init(DSL dsl, LogLevel logLvl = LogLevel.INFO) {
@@ -95,51 +95,6 @@ class Logger implements Serializable {
     tmpLogger.deprecated('Logger.init(DSL dsl, logLevel)','Logger.init(Script script, logLevel)')
   }
 
-  /**
-   * Initializes the logger with DSL/steps object and configuration map
-   *
-   * @param dsl The DSL object of the current pipeline script (available via this.steps in pipeline scripts)
-   * @param map The configuration object of the pipeline
-   * @deprecated
-   */
-  @NonCPS
-  static void init(DSL dsl, Map map) {
-    LogLevel lvl
-    if (map) {
-      lvl = map[ConfigConstants.LOGLEVEL] ?: LogLevel.INFO
-    } else {
-      lvl = LogLevel.INFO
-    }
-    init(dsl, lvl)
-  }
-
-  /**
-   * Initializes the logger with DSL/steps object and loglevel as string
-   *
-   * @param dsl The DSL object of the current pipeline script (available via this.steps in pipeline scripts)
-   * @param sLevel the log level as string
-   * @deprecated
-   */
-  @NonCPS
-  static void init(DSL dsl, String sLevel) {
-    if (sLevel == null) sLevel = LogLevel.INFO
-    init(dsl, LogLevel.fromString(sLevel))
-  }
-
-  /**
-   * Initializes the logger with DSL/steps object and loglevel as integer
-   *
-   * @param dsl The DSL object of the current pipeline script (available via this.steps in pipeline scripts)
-   * @param iLevel the log level as integer
-   *
-   * @deprecated
-   */
-  @NonCPS
-  static void init(DSL dsl, Integer iLevel) {
-    if (iLevel == null) iLevel = LogLevel.INFO.getLevel()
-    init(dsl, LogLevel.fromInteger(iLevel))
-  }
-
   /**
    * Initializes the logger with CpsScript object and LogLevel
    *

src/jenkins-pipeline-library.gdsl

@@ -30,12 +30,9 @@ contributor(pipelineCtx) {
   method(name: 'execMaven', type: 'void', params: [config: Map], doc: 'Executes maven with the given configuration')
   method(name: 'execMavenRelease', type: 'void', params: [config: Map], doc: 'Performs a maven release with the given configuration')
   method(name: 'execNpm', type: 'void', params: [config: Map], doc: 'Executed NPM with the given configuration')
-  method(name: 'getBuildParameters.groovy', type: String, doc: 'Returns the current build parameters')
   method(name: 'getScmUrl', type: String, doc: 'Returns the current scm url')
   method(name: 'getScmUrl', type: String, params: [config: Map], doc: 'Returns the current scm url')
-  method(name: 'notifyMail', type: 'void', params: [config: Map], doc: 'Sends mail notification with the given configuration')
   method(name: 'setBuildName', type: 'void', doc: 'Sets the current build name to #BUILD_NUMBER GIT_BRANCH')
-  method(name: 'setGitBranch', type: 'void', doc: 'Detects the current git branch and sets the result into GIT_BRANCH environment variable')
   method(name: 'setScmUrl', type: 'void', params: [config: Map], doc: 'Detects the current scm url and sets the result into SCM_URL environment variable')
   method(name: 'setupTools', type: 'void', params: [config: Map], doc: 'Setup tools configured in the provided configuration')
   method(name: 'sshAgentWrapper', type: 'void', params: [sshTarget: String, body: Closure], doc: 'Provides auto lookup for ssh credential and wraps body into an sshagent')
@@ -58,7 +55,6 @@ contributor(pipelineCtx) {
 def ansible = context(ctype: "ansible")
 contributor(ansible) {
   method(name: 'execPlaybook', type: 'void', params: [config: Map], doc: 'Executes a ansible playbook with the given configuration.')
-  method(name: 'checkoutRequirements', type: 'void', params: [requirementsYmlPath: String], doc: 'Deprecated, use ansible.checkoutRoles instead.')
   method(name: 'checkoutRoles', type: 'void', params: [galaxyRoleFile: String], doc: 'Checks out ansible galaxy roles based upon a provided path to a requirements YAML file.')
   method(name: 'checkoutRoles', type: 'void', params: [config: Map], doc: 'Checks out ansible galaxy roles based upon a provided pipeline configuration.')
   method(name: 'getGalaxyRoleInfo', type: 'Object', params: [role: 'io.wcm.devops.jenkins.pipeline.tools.ansible.Role'], doc: 'Calls the ansible galaxy API for role information')
@@ -155,7 +151,7 @@ contributor(notify) {
   method(name: 'teams', type: 'void', params: [config: Map], doc: 'Triggers an MS Teams notification')
 }
 
-def wrap = context(ctype: "wrap")
+def wrap = context(ctype: "wrappers")
 contributor(wrap) {
   method(name: 'color', type: 'void', params: [config: Map, closure: Closure], doc: 'Enables color output in Jenkins console by using the ansiColor step.')
 }