api documentation for release-it (v2.7.1)

Interactive release tool for Git repositories. Increment version, commit, tag, push, build, publish to npm. Supports to build and release to a distribution/component repository.

table of contents

  1. module release-it
    1. function release-it.cli (args)
    2. function release-it.execute (opts)
    3. object release-it.git
    4. object release-it.shell
    5. object release-it.tasks
    6. object release-it.util
  2. module release-it.cli
    1. function release-it.cli.help ()
    2. function release-it.cli.version ()
  3. module release-it.git
    1. function release-it.git.clone (repo, dir)
    2. function release-it.git.commit (path, message, version)
    3. function release-it.git.getChangelog (options)
    4. function release-it.git.getGithubToken (tokenRef)
    5. function release-it.git.getLatestTag ()
    6. function release-it.git.getRemoteUrl ()
    7. function release-it.git.hasChanges (repo)
    8. function release-it.git.isGitRepo ()
    9. function release-it.git.isWorkingDirClean (requireCleanWorkingDir)
    10. function release-it.git.push (remoteUrl, pushUrl)
    11. function release-it.git.pushTags (version, pushUrl)
    12. function release-it.git.release (options, remoteUrl, tagName)
    13. function release-it.git.stage (file)
    14. function release-it.git.stageDir (baseDir)
    15. function release-it.git.status ()
    16. function release-it.git.tag (version, tag, annotation)
  4. module release-it.shell
    1. function release-it.shell.build (command)
    2. function release-it.shell.bump (file, version)
    3. function release-it.shell.copy (files, options, target)
    4. function release-it.shell.mkCleanDir (dir)
    5. function release-it.shell.npmPublish (path, tag)
    6. function release-it.shell.popd ()
    7. function release-it.shell.pushd (path)
    8. function release-it.shell.run (command, commandArgs)
    9. function release-it.shell.runTemplateCommand (command)
  5. module release-it.tasks
    1. function release-it.tasks.run (options)
  6. module release-it.util
    1. function release-it.util.format (template, replacements)
    2. function release-it.util.increment (version, increment, identifier)
    3. function release-it.util.isValidVersion (value)
    4. function release-it.util.template (input, context)

module release-it

function release-it.cli (args)

function release-it.execute (opts)

module release-it.cli

function release-it.cli.help ()

function release-it.cli.version ()

module release-it.git

function release-it.git.clone (repo, dir)

function release-it.git.commit (path, message, version)

function release-it.git.getChangelog (options)

function release-it.git.getGithubToken (tokenRef)

function release-it.git.getLatestTag ()

function release-it.git.getRemoteUrl ()

function release-it.git.hasChanges (repo)

function release-it.git.isGitRepo ()

function release-it.git.isWorkingDirClean (requireCleanWorkingDir)

function release-it.git.push (remoteUrl, pushUrl)

function release-it.git.pushTags (version, pushUrl)

function release-it.git.release (options, remoteUrl, tagName)

function release-it.git.stage (file)

function release-it.git.stageDir (baseDir)

function release-it.git.status ()

function release-it.git.tag (version, tag, annotation)

module release-it.shell

function release-it.shell.build (command)

function release-it.shell.bump (file, version)

function release-it.shell.copy (files, options, target)

function release-it.shell.mkCleanDir (dir)

function release-it.shell.npmPublish (path, tag)

function release-it.shell.popd ()

function release-it.shell.pushd (path)

function release-it.shell.run (command, commandArgs)

function release-it.shell.runTemplateCommand (command)

module release-it.tasks

function release-it.tasks.run (options)

module release-it.util

function release-it.util.format (template, replacements)

function release-it.util.increment (version, increment, identifier)

function release-it.util.isValidVersion (value)

function release-it.util.template (input, context)

[ this document was created with utility2 ]