Field Detail

• public static final java.lang.String DEFAULT_REGISTRY

  Default npmjs registry.

  Default:

  "https://registry.npmjs.org/"

• public static final java.lang.String NPMRC_FILE

  Constant of .npmrc file name

  Default:

  "~/.npmrc"

• public static final java.lang.String PACKAGE_JSON

  Constant of package.json file name

  Default:

  "package.json"

Property Detail

• java.util.Map _packageInfo

  Package information extracted from PACKAGE_JSON.

• java.lang.String email

  npm user email, required for publishing

• java.lang.String packageJsonFile

  File name of package.json.

  Default:

  PACKAGE_JSON

• java.lang.String registry

  npm registry url

• java.lang.String scope

  npm package scope

• java.lang.Object steps

  Reference to the groovy pipeline variable.

• java.lang.String tokenCredential

  Jenkins credential ID for NPM token.

  Note:

  The content of token could be base64 encoded "username:password".

• java.lang.String usernamePasswordCredential

  Jenkins credential ID for NPM username/base64_password

Constructor Detail

• Registry(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 npm = new Registry(this)
   

  Parameters:

  steps - The workflow steps object provided by the Jenkins pipeline

Method Detail

• void audit()

  Run npm audit with default config.

  Note:

  npm audit cannot be ran on private registry, so we reset config before audit.

• void clearPackageInfoCache()

  Reset package info cache

• java.util.Map getPackageInfo()

  Get current package information from package.json.

  Note:

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

  Expected keys in the result Map:

  • name - name of the package. For example, "explorer-jes".
  • scope - scope of the package. Optional. For example, "zowe". Please note this value does NOT have @ included.
  • description - description of the package if defined. For example, "A UI plugin to handle z/OS jobs.".
  • version - version of the package. For example, "1.2.3".
  • versionTrunks - Map version trunks returned from Utils.parseSemanticVersion.
  • license - license of the package if defined. For example, "EPL-2.0".
  • registry - publish registry of the package if defined.
  • scripts - List of scripts of the package defined. For example, ["build", "test", "start", "coverage"].

  Returns:

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

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

  Initialize npm registry properties.

  Note:

  The below parameters are supported keys of the args Map.

  Parameters:

  registry - the registry URL

  tokenCredential - Jenkins credential ID for NPM token. Optional.

  usernamePasswordCredential - Jenkins credential ID for NPM username/base64_password. Optional.

  email - NPM user email

  packageJsonFile - package.json file name. Optional, default is PACKAGE_JSON.

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

  Detect npm registry and scope from package.json.

  Note:

  This method is taken out from init(Map) because some registries (like install registries) shouldn't have this. Only publish registry makes sense to get from package.json.

  Note:

  Use similar parameters defined in init(Map) method.

• java.lang.String login(java.util.Map args = [:])

  Login to NPM registry.

  Note:

  Using token credential may receive this error with whoami, but actually npm install is ok.

   + npm whoami --registry https://zowe.jfrog.io/zowe/api/npm/npm-release/
   npm ERR! code E401
   npm ERR! Unable to authenticate, need: Basic realm="Artifactory Realm"
   

  This happens if we set "//zowe.jfrog.io/zowe/api/npm/npm-release/:_authToken", but if we set "_auth=<token>", everything is ok.

  Is this a bug of Artifactory?

  So for now, only usernamePasswordCredential works well.

  Note:

  Use similar parameters defined in init(Map) method.

  See Also:

  jFrog Artifactory - Configuring the npm Client for a Scope Registry

  Returns:

  username who login

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

  Publish npm package with tag.

  Example:

       // publish package 1.2.3-snapshot-20190101010101 with dev tag
       npm.publish(
           tag     : 'dev',
           version : '1.2.3-snapshot-20190101010101'
       )
   

  Note:

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

  Parameters:

  tag - npm publish tag. Optional, default is empty which is (@code latest).

  version - package version to publish.

• void resetConfig()

  Reset NPN configurations.

  Note:

  This will also reset login information, which effectly logout from all repositories.

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

  Declare a new version of npm package.

  Note:

  This task will bump the package version defined in package.json, 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
       npm.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 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 npm package.

  See Also:

  version(Map)