If you wish to add the release-script to your project, please follow these steps (taken from the official documentation):
-
Add this module to your
devDependencies
:npm i -D @alcalzone/release-script
-
Add a new
npm
script inpackage.json
:"scripts": { ... other scripts ... "release": "release-script" }
-
Add a placeholder to
README.md
(for your own convenience)## Changelog <!-- Placeholder for the next version (at the beginning of the line): ### **WORK IN PROGRESS** -->
or
CHANGELOG.md
if you prefer to have a separate changelog (notice that there is one less#
):# Changelog <!-- Placeholder for the next version (at the beginning of the line): ## **WORK IN PROGRESS** -->
For further information, check the official documentation.