semantic-release-license

semantic-release plugin to update your license file on new releases.

Step	Description
verifyConditions	Verify the presence of a license file and makes sur it can detect it
prepare	Update the license file based on its type

Install

1npm install -D semantic-release-license

Usage

The plugin can be configured in the semantic-release configuration file:

1module.exports = {
2  plugins: [
3    'semantic-release-license',
4    /*
5     * Use the git plugin to commit the updated license file
6     * Note: make sure semantic-release-license is run BEFORE the git plugin
7     * otherwise you git won't pick your updated LICENSE.
8     */
9    ['@semantic-release/git', {
10      assets: ['LICENSE']
11    }]
12  ]
13}

License updates

MIT

• Copyright date

BSL

• Licensed work version
• Copyright date
• Change date

Options

You can configure the plugin by passing options:

1module.exports = {
2  plugins: [
3    ['semantic-release-license', {
4      license: {
5        path: 'path/to/MY_LICENSE.txt'
6      }
7    }]
8  ]
9}

We use a license root property to avoid conflicts with semantic-release CLI options (see here).

Options	Description	Default
license.path	The path to your license path	The plugin tries to automatically detect it