releasy

Releasy

Releasy helps you release versions of your projects easily! It currently works with NodeJS package.json files and C# AssemblyInfo.cs files.

Releasy will automatically do the following:

• Increment the version in the file
• Commit the changed version file
• Create a Git tag with the version
• Push the tag and changes to the Git remote

Usage

If you want to see what happens, just grab it (npm i -g releasy) and run anything with the --dry-run flag. This will only show you what would happen, without actually applying any changes. At any time, calling releasy -h or releasy --help will show you the list of options available. Try it.

The default behavior increments the patch and creates a beta prerelease using the package.json file.

$ releasy

Old version: 1.0.0
New version: 1.0.1-beta
prompt: Are you sure?:  (yes)
Starting release...
Version bumped to 1.0.1-beta
File package.json added # git add package.json
File package.json committed # git commit package.json -m "Release v1.0.1-beta"
Tag created: v1.0.1-beta #git tag v1.0.1-beta -m "Release v1.0.1-beta"
Pushed commit and tags # git push && git push --tags
All steps finished successfuly.

You can increment other parts of the version by providing a first argument:

$ releasy patch # 1.2.3 => 1.2.4-beta
$ releasy minor # 1.2.3 => 1.3.0-beta
$ releasy major # 1.2.3 => 2.0.0-beta
$ releasy prerelease # 1.2.3-beta.4 => 1.2.3-beta.5
$ releasy pre # is an alias to 'prerelease'

When you are ready to promote a beta version to stable, use the promote argument:

$ releasy promote # 1.2.3-beta.4 => 1.2.3

Or, if you want to increment directly as stable version, use the --stable flag:

$ releasy --stable # 1.2.3 => 1.2.4

To apply a custom prerelease identifier:

$ releasy --tag alpha # 1.2.3 => 1.2.4-alpha

Options file

You may create a file called _releasy.yaml so that any values set in this file will be used as default. If you prefer, .yml and .json extensions will also work. Below is a sample _releasy.yaml file.

# https://github.com/vtex/releasy
type: prerelease                # prerelease as default increment
filename: otherpackage.json     # different version file as default

# you may also use any other options available in the command line
stable: true        # release stable version
tag: alpha          # use alpha as prerelease name
dry-run: true       # always use dry run mode
# etc

Different version files

Releasy currently supports both NodeJS' package.json and .NET C#'s AssemblyInfo.cs. The default file used is package.json, but you may specify a different value though the options file or in the command line.

JSON files

If the specified file has a .json extension, it will be treated as Node's package.json. This means that the version will be read from and written to your package's version field.

C# files

If the specified file has a .cs extension, it will be treated as an AssemblyInfo.cs file. As such, the version will be read from and written to assembly version attributes, which are: AssemblyVersion, AssemblyFileVersion and AssemblyInformationalVersion.

In order to conform to the .NET Framework's specification, only the AssemblyInformationalVersion attribute will retain any prerelease version information, while the other two will be stripped of it, keeping only the version numbers.