1.0.5 • Published 2 years ago

semantic-release-license-fork v1.0.5

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

semantic-release-license-fork

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

StepDescription
verifyConditionsVerify the presence of a license file and makes sur it can detect it
prepareUpdate the license file based on its type

Install

npm install -D semantic-release-license-fork

Usage

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

module.exports = {
  plugins: [
    'semantic-release-license-fork',
    /*
     * Use the git plugin to commit the updated license file
     * Note: make sure semantic-release-license-fork is run BEFORE the git plugin
     * otherwise you git won't pick your updated LICENSE.
     */
    ['@semantic-release/git', {
      assets: ['LICENSE']
    }]
  ]
}

License updates

MIT, ISC

  • Copyright date

BSD-2-Clause, BSD-3-Clause, UPL-1.0

  • Copyright date

Options

You can configure the plugin by passing options:

module.exports = {
  plugins: [
    ['semantic-release-license-fork', {
      license: {
        path: 'path/to/MY_LICENSE.txt'
      }
    }]
  ]
}

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

OptionsDescriptionDefault
license.pathThe path to your license pathThe plugin tries to automatically detect it
1.0.5

2 years ago

1.0.4

2 years ago

1.0.3

2 years ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago