@standard-release/app

GitHub App for creating GitHub Releases, following the Conventional Commits and SemVer specifications

Please consider following this project's author, Charlike Mike Reagent, and ⭐ the project to show your ❤️ 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 by itself.

Table of Contents

• Install the App
• Usual 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 the App

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

Usual Flow

This app works best with it's @standard-release/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 @standard-release/cli (as devDependency for example)
4. Configure your CI to run standard-release only on master branch

Note: If you don't want automatic publish on continuous integration services, but want to run it locally whenever you want, then you should run standard-release --no-ci instead. See the cli docs for more info.

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, or Sindre's np. 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

See Also

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

• 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
• gitcommit: Lightweight and joyful git commit replacement. Conventional Commits compliant. | homepage
• parse-commit-message: Extensible parser for git commit messages following Conventional Commits Specification | 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? 💵 Check the Partner, Sponsor or Omega-level tiers! 🎉 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! 🚀

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

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. 💖

License

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