Skip to content

Shipped a standard npm publish workflow with one click.

License

Notifications You must be signed in to change notification settings

ulivz/quick-publish

Repository files navigation

quick-publish

npm version

Shipped a standard npm publish workflow with one click.

Motivation

As a maintainer for a large number of NPM packages, it will be very cumbersome if you manually input the semantic version, generate changelog, git and npm tag etc., this tooling is to help you do all these things with one click.

Features

  • Semantic version selection.
  • Create git tag.
  • Create remote git tag.
  • Create npm tag.
  • Generate or update CHANGELOG.md

Install

npm i quick-publish -g      # Global installation
npm i quick-publish -D      # Local installation

Usage

  • Create a one-click release flow:
publish
  • Display help:
Usage:
  $ publish

Commands:
    Shipped a standard `npm publish` workflow with one click.

Options:
  --depcost      Generate or update `DEPCOST.md`, defaults to `false`
  --push         Execute git push & tag push to remote git origin, defaults to `true`
  -h, --help     Display this message
  -v, --version  Display version number

Credits

quick-publish wouldn't exist without the inspirations from following projects:

License

MIT © ULIVZ