new-release [![npm version][npmv-img]][npmv-url] [![github release][ghrelease-img]][ghrelease-url] [![License][license-img]][license-url]

> [MIRROR] Publish 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.

[![Code style][codestyle-img]][codestyle-url]
[![CircleCI linux build][linuxbuild-img]][linuxbuild-url]
[![CodeCov coverage status][codecoverage-img]][codecoverage-url]
[![DavidDM dependency status][dependencies-img]][dependencies-url]
[![Renovate App Status][renovateapp-img]][renovateapp-url]
[![Make A Pull Request][prs-welcome-img]][prs-welcome-url]
[![Semantically Released][new-release-img]][new-release-url]

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][open-issue-url] or ping
@tunnckoCore at Twitter.

[![Become a Patron][patreon-img]][patreon-url]
[![Conventional Commits][ccommits-img]][ccommits-url]
[![NPM Downloads Weekly][downloads-weekly-img]][npmv-url]
[![NPM Downloads Monthly][downloads-monthly-img]][npmv-url]
[![NPM Downloads Total][downloads-total-img]][npmv-url]
[![Share Love Tweet][shareb]][shareu]

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

As of v5, this package is mirror!!

- It's exactly the same copy of the @tunnckocore/release-cli
- Requires: Node.js ^8.11.0 || >=10.13.0

Table of Contents

- Install
- CLI
- 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.11.0 || >=10.13.0. Install it using
yarn or npm.
_We highly recommend to use Yarn when you think to contribute to this project._

``bash
$ yarn global add new-release


or


$ yarn add --dev new-release
`

CLI

Just run new-release or tunnckocore-release and rest.
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:
new-release [flags]

Flags:
--ci to be called on CI or locally, default: true
--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

`

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/config: All the configs for all the tools, in one place | homepage
- detect-next-version: Calculates next version, based on given commit message and following… more | homepage
- git-commits-since: Get all commits since given period of time or by… more | homepage
- gitcommit: Lightweight and joyful git commit replacement. Conventional Commits compliant. | git commit replacement. Conventional Commits compliant."" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">homepage
- recommended-bump: Calculates recommended bump (next semver version) based on given array… more | homepage based on given array of commit messages following Conventional Commits specification")

back to top

Contributing

$3

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

$3

[Become a Partner or Sponsor?][patreon-url] :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][npmv-url] and yarnpkg.com sites too! :rocket:

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

$3

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.

$3

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 ` & contributors.
Released under the [Apache-2.0 License][license-url].

[npmv-url]: https://www.npmjs.com/package/new-release
[npmv-img]: https://badgen.net/npm/v/new-release?icon=npm

[ghrelease-url]: https://github.com/tunnckoCoreLabs/new-release/releases/latest
[ghrelease-img]: https://badgen.net/github/release/tunnckoCoreLabs/new-release?icon=github

[license-url]: https://github.com/tunnckoCoreLabs/new-release/blob/master/LICENSE
[license-img]: https://badgen.net/npm/license/new-release

[codestyle-url]: https://github.com/airbnb/javascript
[codestyle-img]: https://badgen.net/badge/code%20style/airbnb/ff5a5f?icon=airbnb

[linuxbuild-url]: https://circleci.com/gh/tunnckoCoreLabs/new-release/tree/master
[linuxbuild-img]: https://badgen.net/circleci/github/tunnckoCoreLabs/new-release/master?label=build&icon=circleci

[codecoverage-url]: https://codecov.io/gh/tunnckoCoreLabs/new-release
[codecoverage-img]: https://badgen.net/codecov/c/github/tunnckoCoreLabs/new-release?icon=codecov

[dependencies-url]: https://david-dm.org/tunnckoCoreLabs/new-release
[dependencies-img]: https://badgen.net/david/dep/tunnckoCoreLabs/new-release?label=deps

[ccommits-url]: https://conventionalcommits.org/
[ccommits-img]: https://badgen.net/badge/conventional%20commits/v1.0.0/dfb317
[new-release-url]: https://ghub.io/new-release
[new-release-img]: https://badgen.net/badge/semantically/released/05c5ff

[downloads-weekly-img]: https://badgen.net/npm/dw/new-release
[downloads-monthly-img]: https://badgen.net/npm/dm/new-release
[downloads-total-img]: https://badgen.net/npm/dt/new-release

[renovateapp-url]: https://renovatebot.com
[renovateapp-img]: https://badgen.net/badge/renovate/enabled/green
[prs-welcome-img]: https://badgen.net/badge/PRs/welcome/green
[prs-welcome-url]: http://makeapullrequest.com
[paypal-donate-url]: https://paypal.me/tunnckoCore/10
[paypal-donate-img]: https://badgen.net/badge/$/support/purple
[patreon-url]: https://www.patreon.com/bePatron?u=5579781
[patreon-img]: https://badgen.net/badge/patreon/tunnckoCore/F96854?icon=patreon
[patreon-sponsor-img]: https://badgen.net/badge/become/a%20sponsor/F96854?icon=patreon

[shareu]: https://twitter.com/intent/tweet?text=https://github.com/tunnckoCoreLabs/new-release&via=tunnckoCore
[shareb]: https://badgen.net/badge/twitter/share/1da1f2?icon=twitter
[open-issue-url]: https://github.com/tunnckoCoreLabs/new-release/issues/new

[new-release]: https://github.com/tunnckoCore/new-release
[semantic-release]: https://github.com/semantic-release/semantic-release