Skip to content

Latest commit

 

History

History
46 lines (32 loc) · 1.1 KB

20210519_release_script.md

File metadata and controls

46 lines (32 loc) · 1.1 KB

Support for release-script

If you wish to add the release-script to your project, please follow these steps (taken from the official documentation):

Installation

  1. Add this module to your devDependencies:

    npm i -D @alcalzone/release-script
  2. Add a new npm script in package.json:

    "scripts": {
        ... other scripts ...
        "release": "release-script"
    }
  3. 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**
    -->

More information

For further information, check the official documentation.