@tunnckocore/release [![npm version][npmv-img]][npmv-url] [![github release][ghrelease-img]][ghrelease-url] [![License][license-img]][license-url]

> Release and publish a new project to NPM and GitHub, automatically. Following Conventional Commits specification and Semver. It provides GitHub App, similar to [semantic-release][], too.

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.

- Install App
- Basic Flow
- Alternative Flow
- See Also
- Contributing
* Follow the Guidelines
* Support the project
* OPEN Open Source
* Wonderful Contributors
- License

_(TOC generated by verb using markdown-toc)_

Install App

!uptime status
!uptime day
!uptime month
!uptime response

Install this app on your preferred account: Standard Release GitHub App

Automatically publish GitHub releases, based on commits that follows Conventional Commits specification.
Pretty similar to the Semantic Release, but only an App.

back to top

Basic Flow

This app works best with it's CLI for npm publishing, but is not limited to it!
So in case you want to combine both, follow this steps:

1. Install this App
2. Add your NPM_TOKEN env variable (needed for the CLI only) in your CI
3. Install @tunnckocore/release-cli (as devDependency for example)
4. Configure your CI to run tunnckocore-release only on master branch

Note: If you don't want automatic publish on CI service, but want to run it locally whenever you want, then
you should run tunnckocore-release --no-ci instead.

Alternative Flow

Otherwise, you still can use only the App and leave the npm publishing to another tool, for example semantic-release or standard-version. In this case the step is one: just install that app on your preferred account (your own or to some organization).

Basically, how this app works is pretty simple. It will listen to all CI jobs to finish successfully and then publish a GitHub release. If some of the CI stuff fail, it won't do anything. The CI detection is based on a status name check, so it works for Travis, CircleCI, AppVeyor and others.

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

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

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

[license-url]: https://github.com/tunnckoCore/release/blob/master/LICENSE
[license-img]: https://badgen.net/npm/license/@tunnckocore/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/tunnckoCore/release/tree/master
[linuxbuild-img]: https://badgen.net/circleci/github/tunnckoCore/release/master?label=build&icon=circleci

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

[dependencies-url]: https://david-dm.org/tunnckoCore/release
[dependencies-img]: https://badgen.net/david/dep/tunnckoCore/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/@tunnckocore/release
[downloads-monthly-img]: https://badgen.net/npm/dm/@tunnckocore/release
[downloads-total-img]: https://badgen.net/npm/dt/@tunnckocore/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/tunnckoCore/release&via=tunnckoCore
[shareb]: https://badgen.net/badge/twitter/share/1da1f2?icon=twitter
[open-issue-url]: https://github.com/tunnckoCore/release/issues/new

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