generator-version-file

A Yeoman Generator for keeping a version file up to date

Overview

This generator is meant to be used with projects of any language to keep an internal version number in the code up to date with the actual package version. This chore of the release process can be easily added to a pipeline using this tool.

It was concieved especially to be used with projects of any language that use commitizen and stardard-version for release and changelog generation.

Currently Supported Languages

Each file and template is built into the generator (additional languages welcome!)

• Javascript
• Ruby
• Python

Usage

standard-version

Ideally, this generator should be used with standard-version as part of a release process to keep the version in the package in sync with the version in your package.json. You can direct that to happen in one of the two files to configure standard-version. Both of these options presuppose that you have installed standard-version already.

:warning: NOTE: This you must run yo version-file once manually to initialize the .yo-rc file before using this as part of your release process. :warning:

.versionrc

{
  "scripts": {
    "postbump": "yo version-file --force --git"
  }
}

package.json

{
  "standard-version": {
    "scripts": {
      "postbump": "yo version-file --force --git"
    }
  }
}

Global (not recommended)

First, install Yeoman and generator-version-file using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-version-file

Then generate your version file:

yo version-file

Getting To Know Yeoman

• Yeoman has a heart of gold.
• Yeoman is a person with feelings and opinions, but is very easy to work with.
• Yeoman can be too opinionated at times but is easily convinced not to be.
• Feel free to learn more about Yeoman.

License

MIT © Dan Rosenbloom