@eljs/release

release npm package easily

Usage no npm install needed!

<script type="module">
  import eljsRelease from 'https://cdn.skypack.dev/@eljs/release';
</script>

README

release

release your npm package easily

Install

$ npm i @eljs/release --save-dev

$ yarn add @eljs/release --dev

Usage

  Usage: release [options]

  Options:
    -v, --version                              Output the current version
    --latest                                   Generate latest changelog (default: true)
    -t, --repo-type <repo-type>                Publish type, github or gitlab
    -u, --repo-url <repo-url>                  Github repo url to release
    -p, --changelog-preset <changelog-preset>  Customize conventional changelog preset
    -h, --help                             display help for command
  1. add script to your package.json
  "scripts": {
++  "release: "release --repo-type=github"  
  }
  1. submit git with semantic information, https://www.conventionalcommits.org/en/v1.0.0/#summary
  2. run npm run release to publish your package

Options

-t, --repo-type: 'github' | 'gitlab'

which type should the package publish to, default github

-u, --repo-url?: string

when publish successful, it will open a release web page to sync changelog in github type, the repoUrl option represent the web page, default is repository.url in package.json

-p, --changelog-preset?: string

customize conventional changelog preset, default https://github.com/chnliquan/changelog-preset

--latest?: boolean

should generate LATEASTLOG.md which represent the latest changelog in project root, default true

LICENSE

MIT