https://github.com/0-vortex/semantic-release-license-fork
Opinionated fork of cbhq/semantic-release-license with osi+fsf popular licenses
https://github.com/0-vortex/semantic-release-license-fork
Last synced: 4 days ago
JSON representation
Opinionated fork of cbhq/semantic-release-license with osi+fsf popular licenses
- Host: GitHub
- URL: https://github.com/0-vortex/semantic-release-license-fork
- Owner: 0-vortex
- License: mit
- Created: 2021-12-12T02:38:17.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-12-19T06:01:40.000Z (over 4 years ago)
- Last Synced: 2025-08-09T15:46:07.511Z (11 months ago)
- Language: TypeScript
- Homepage:
- Size: 1.11 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# semantic-release-license-fork
[**semantic-release**](https://github.com/semantic-release/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
```bash
npm install -D semantic-release-license-fork
```
## Usage
The plugin can be configured in the [**semantic-release** configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration):
```js
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:
```js
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](https://github.com/semantic-release/semantic-release/issues/1696)).
| Options | Description | Default |
|---------|-------------|---------|
| `license.path` | The path to your license path | The plugin tries to automatically detect it |