https://github.com/thebenforce/versioning-tool

CLI tool for updating npm package version and tagging git repos for release.
https://github.com/thebenforce/versioning-tool

Last synced: 22 days ago
JSON representation

CLI tool for updating npm package version and tagging git repos for release.

• Host: GitHub
• URL: https://github.com/thebenforce/versioning-tool
• Owner: theBenForce
• License: mit
• Created: 2018-10-08T12:36:19.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2018-10-08T18:47:30.000Z (about 6 years ago)
• Last Synced: 2024-10-04T21:43:53.797Z (about 1 month ago)
• Language: TypeScript
• Size: 82 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# versioning-tool

CLI tool for updating npm package version and tagging git repos for release.

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)

[![Version](https://img.shields.io/npm/v/versioning-tool.svg)](https://npmjs.org/package/versioning-tool)

[![Build Status](https://travis-ci.com/theBenForce/versioning-tool.svg?branch=master)](https://travis-ci.com/theBenForce/versioning-tool)

[![Open Issues](https://img.shields.io/github/issues-raw/theBenForce/versioning-tool.svg)](https://github.com/theBenForce/versioning-tool/issues)

[![Downloads/week](https://img.shields.io/npm/dw/versioning-tool.svg)](https://npmjs.org/package/versioning-tool)

[![License](https://img.shields.io/npm/l/versioning-tool.svg)](https://github.com/theBenForce/versioning-tool/blob/master/package.json)

* [versioning-tool](#versioning-tool)

* [Usage](#usage)

* [Version Formatting](#version-formatting)

* [Commands](#commands)

# Usage

```sh-session

$ npm install -g versioning-tool

$ vt COMMAND

running command...

$ vt (-v|--version|version)

versioning-tool/2018.10.8-9 darwin-x64 node-v10.1.0

$ vt --help [COMMAND]

USAGE

  $ vt COMMAND

...

```

# Version Formatting

You can specify the date format that will be used by adding the following section to your package.json file:

```json

"versioning": {

  "date-format": "yyyy.mm.dd"

}

```

# Commands

* [`vt current`](#vt-current)

* [`vt help [COMMAND]`](#vt-help-command)

* [`vt update`](#vt-update)

## `vt current`

Displays current version

```

USAGE

  $ vt current

OPTIONS

  -h, --help  show CLI help

```

_See code: [src/commands/current.ts](https://github.com/theBenForce/versioning-tool/blob/v2018.10.8-9/src/commands/current.ts)_

## `vt help [COMMAND]`

display help for vt

```

USAGE

  $ vt help [COMMAND]

ARGUMENTS

  COMMAND  command to show help for

OPTIONS

  --all  see all commands in CLI

```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.1.2/src/commands/help.ts)_

## `vt update`

Adds a git tag for next version and update package.json to match.

```

USAGE

  $ vt update

OPTIONS

  -f, --format=format    Format that the date portion should be in

  -h, --help             show CLI help

  -m, --message=message  The message you want attached to the git tag

  -p, --push             Run a git push and git push --tags after updating the version

  -v, --version=version  Force a new version number

```

_See code: [src/commands/update.ts](https://github.com/theBenForce/versioning-tool/blob/v2018.10.8-9/src/commands/update.ts)_