Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

conventional-release-setup

1.1.0 • Public • Published

conventional-release-setup

NPM

NPM version Build Status

A command-line tool for setting up a package for committing and releasing with conventional commits:

npx conventional-release-setup

Installation

To install the package globally:

# with npm 
npm install --global conventional-release-setup
 
# with yarn 
yarn global add conventional-release-setup

Usage

If the package is installed globally, you can execute it in the command-line:

conventional-release-setup

Otherwise, you can install and execute the package binary like so:

npx conventional-release-setup

Script

What does the script do?

It updates package.json:

  • appends -alpha to version
  • adds script release

Installs devDependencies:

Copies configs to your project:

Release

If -alpha is appended to your package.json version:

{
  "version": "1.0.0-alpha"
}

Then you can run a release like so:

npm run release # npx standard-version --no-verify 

Otherwise, you can release as a target type imperatively:

npx standard-version --release-as 1.0.0

Or if you want to use the current version as your first release:

npx standard-version --first-release

Release

Only collaborators with credentials can release and publish:

npm run release
git push --follow-tags && npm publish

License

MIT

Install

npm i conventional-release-setup

DownloadsWeekly Downloads

42

Version

1.1.0

License

MIT

Unpacked Size

9.71 kB

Total Files

7

Last publish

Collaborators

  • avatar