@tunnckocore/release-cli

Publish new project to NPM following Conventional Commits specification and SemVer. Uses git-commits-since for detecting git commits since last SemVer tag and detect-next-version for what next version bump should be.

Please consider following this project's author, Charlike Mike Reagent, and :star: the project to show your :heart: and support.

If you have any how-to kind of questions, please read the Contributing Guide and Code of Conduct documents.
For bugs reports and feature requests, please create an issue or ping @tunnckoCore at Twitter.

Project is semantically & automatically released on CircleCI with new-release and its New Release GitHub App.

Table of Contents

• Install
• CLI
• API
• See Also
• Contributing
  • Follow the Guidelines
  • Support the project
  • OPEN Open Source
  • Wonderful Contributors
• License

(TOC generated by verb using markdown-toc)

Install

This project requires Node.js ^8.10.0 || >=10.13.0. Install it using yarn or npm.
We highly recommend to use Yarn when you think to contribute to this project.

$ yarn global add @tunnckocore/release-cli
# or
$ yarn add --dev @tunnckocore/release-cli

CLI

Just run release or tunnckocore-release and watch. It will detect next needed bump for your package and execute npm version and npm publish.

Make note that it is meant to be used in CI services, but if you want to run it locally pass the --no-ci flag, otherwise it will exit the program.

Usage:
  release [flags]

Flags:
  --ci          to be called on CI or locally; default: true
  --dry         dry run, won't publish; it will output metadata
  --cwd         a directory where the package.json is; default: process.cwd()
  --token       a npm token to be used, or pass NPM_TOKEN env
  --registry    a npm registry to be published to, or pass NPM_REGISTRY env

API

Generated using docks.

back to top

See Also

Some of these projects are used here or were inspiration for this one, others are just related. So, thanks for your existance!

• @tunnckocore/create-project: Create and scaffold a new project, its GitHub repository and… more | homepage
• @tunnckocore/execa: Thin layer on top of execa that allows executing multiple… more | homepage
• @tunnckocore/scripts: Universal and minimalist scripts & tasks runner. | homepage
• asia: Blazingly fast, magical and minimalist testing framework, for Today and… more | homepage
• detect-next-version: Calculates next version, based on given commit message and following… more | homepage
• docks: Extensible system for parsing and generating documentation. It just freaking… more | homepage
• git-commits-since: Get all commits since given period of time or by… more | homepage

back to top

Contributing

Follow the Guidelines

Please read the Contributing Guide and Code of Conduct documents for advices.
For bugs reports and feature requests, please create an issue or ping @tunnckoCore at Twitter.

Support the project

Become a Partner or Sponsor? :dollar: Check the Partner, Sponsor or Omega-level tiers! :tada: You can get your company logo, link & name on this file. It's also rendered on package page in npmjs.com and yarnpkg.com sites too! :rocket:

Not financial support? Okey! Pull requests, stars and all kind of contributions are always welcome. :sparkles:

OPEN Open Source

This project is following OPEN Open Source model

Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is built on collective efforts and it's not strongly guarded by its founders.

There are a few basic ground-rules for its contributors

1. Any significant modifications must be subject to a pull request to get feedback from other contributors.
2. Pull requests to get feedback are encouraged for any other trivial contributions, but are not required.
3. Contributors should attempt to adhere to the prevailing code-style and development workflow.

Wonderful Contributors

Thanks to the hard work of these wonderful people this project is alive! It follows the all-contributors specification.
Don't hesitate to add yourself to that list if you have made any contribution! ;) See how, here.

| Charlike Mike Reagent💻 📖 💬 👀 🔍 | | :---: |

Consider showing your support to them. :sparkling_heart:

License

Copyright (c) 2018-present, Charlike Mike Reagent <[email protected]> & contributors.
Released under the Apache-2.0 License.