README
@justia/releaser
A script to generate releases and changelog
General
This project bundles Release It!, @release-it/conventional-changelog, and custom plugins. It exposes a pre-configured JavaScript object that can be overriden as needed depending on the needs of the project.
How?
Install
Into project: npm install -D @justia/releaser
Globally: npm install -g @justia/releaser
Use
If you have this project installed globally you can use the following commands:
Run a release:
jReleaser
Run a with calendar versioning:
jReleaser --calver=YYYY.MM.MICRO
The format is optional.
Run a with a custom config:
You can extend the configuration using the config parameter.
jReleaser --config='{"github":{"release":false}}'
NPM Scripts
To avoid having to install the global package, you can also add npm scripts to your package.json
's npm scripts: {}
object.
For example:
"release": "jReleaser"
Use Config Only
If you want to skip using the tool, and instead use release-it
as intended, you can do that too.
Add a file called release-it.js
to your project root, with the following contents:
'use strict';
const config = require('@justia/releaser').default;
module.exports = {
plugins: config.plugins,
git: config.git,
gitHub: config.gitHub,
npm: config.npm,
};
You can configure the above as necessary to suit your project.
You can now run release-it
commands, passing our config:
release-it --config='release-it.js'