package version

Aliases: 
  • bump
    •  
    Parameters:
    Name Type Required Default Hint
    version string false The new version to set into this package
    message string false The message to use when commiting the new tag
    tagVersion boolean false Whether or not to tag the repo
    tagPrefix string false The tag prefix to use before the version number
    force boolean false false Skip the check if to see if the Git repo is clean
    major boolean false Increment the major version number
    minor boolean false Increment the minor version number
    patch boolean false Increment the patch version number

    Command Usage

    Interact with your package's version number. This command must be run from the root of the package.

    Running this command with no parameters will output the current version. (Same as "package show version")

    package version
    Set a specific version number by passing it into this command. (Same as "package set version=1.0.0")
    package version 1.0.0
    "Bump" the existing version number up by one unit and save in your box.json.
    Specify the part of the version to increase with the major, minor, or patch parameter.
    Note, "package version" is aliased as "bump".
    bump --major

    bump --minor

    bump --patch
    If multiple version parts are specified, the "larger" one will be used starting with major.
    If a version AND a flag are both supplied, the version will be used and the flag(s) ignored.
    If your package is a Git repo AND it is clean, this command will attempt to tag it with the new version number.
    You can provide an optional commit message for this tag:
    bump --major message="finalizing release"
    If you don't want the tagging functionality, provide the "tagVersion" flag or turn
    off the setting globally with config setting.
    bump --major tagVersion=false

    config set tagVersion=false