triage-new-issues
Version:
A GitHub App, built with [probot][] that adds `triage` label to newly-created issues which don't have labels
208 lines (146 loc) • 11.3 kB
Markdown
# triage-new-issues [![npm version][npmv-img]][npmv-url] [![github release][github-release-img]][github-release-url] [![License][license-img]][license-url]
> A [GitHub App](https://github.com/apps/triage-new-issues), built with [probot][] that adds `triage` label to newly-created issues which don't have labels
<div id="thetop"></div>
_You might also be interested in [hela][highlighted-link] or in the other [related projects](#related-projects)._
_The hosted app may have some downtimes! Sorry for that, i'm trying to keep it up, but soon will be stable and always up!_
## Quality Assurance :100:
[![bitHound Code][bithound-code-img]][bithound-code-url]
[![Code Style Standard][standard-img]][standard-url]
[![Linux Build][circleci-img]][circleci-url]
[![Code Coverage][codecov-img]][codecov-url]
[![bitHound Score][bithound-score-img]][bithound-score-url]
[![bitHound Deps][bithound-deps-img]][bithound-deps-url]
[![Dependencies Status][dependencies-img]][dependencies-url]
If you have any _how-to_ kind of questions, please read [Code of Conduct](./CODE_OF_CONDUCT.md) and **join the chat** rooms or [open an issue][open-issue-url].
You may also read the [Contributing Guide](./CONTRIBUTING.md). There, beside _"How to contribute?"_, we describe everything **_stated_** by the badges.
[![tunnckoCore support][chat-img]][chat-url]
[![Code Format Prettier][prettier-img]][prettier-url]
[![Node Security Status][nodesecurity-img]][nodesecurity-url]
[![Conventional Commits][ccommits-img]][ccommits-url]
[![Make A Pull Request][prs-welcome-img]][prs-welcome-url]
[![Node Version Required][nodeversion-img]][nodeversion-url]
[![Renovate App Status][renovate-img]][renovate-url]
<!--
<a target="_blank" rel="nofollow" href="https://app.codesponsor.io/link/K7yYzzA5nb2ZDR4GTKmgUdfe/tunnckoCore/triage-new-issues">
<img alt="Sponsor" width="888" height="68" src="https://app.codesponsor.io/embed/K7yYzzA5nb2ZDR4GTKmgUdfe/tunnckoCore/triage-new-issues.svg" />
</a>
<p></p>-->
[![All Contributors Spec][all-contributors-img]](#contributors)
[![Newsletter Subscribe][tinyletter-img]][tinyletter-url]
[![PayPal Author Support][paypal-donate-img]][paypal-donate-url]
[![Share Love Tweet][share-love-img]][share-love-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]
## Table of Contents
- [Use programmatically](#use-programmatically)
- [Install it to your profile](#install-it-to-your-profile)
- [Deploying](#deploying)
- [Related Projects](#related-projects)
- [Contributing](#contributing)
- [Contributors](#contributors)
- [Users](#users)
- [License](#license)
_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_
## Use programmatically
This project requires [**Node.js**][nodeversion-url] **v8** or above. Install it using [**yarn**](https://yarnpkg.com) **v1** or above / [**npm**](https://www.npmjs.com) **v5** or above.
If you want to use it programmatically install it with yarn.
```
$ yarn add triage-new-issues
```
## Install it to your profile
Go to https://github.com/apps/triage-new-issues and click the green "install" button.
Very much appreciated the work of **Gyandeep Singh ([@gyandeeps](https://github.com/gyandeeps))** on
the plugin for the [ESLint's GitHub Bot](https://github.com/eslint/eslint-github-bot/tree/4dd943a51b415b0b2053b4a4ae75a4e9244fcb09/src/plugins/triage)!
In addition to it, to safe UI clicking and time, I just added ability to auto-remove `triage` label when another label is added.
## Deploying
We hosting it on https://triage-new-issues.now.sh/, but if you want to host it yourself
1. Decide where to host
2. Check out [Probot Docs on deploying](https://probot.github.io/docs/development/)
3. Make sure your deployment service run the `start` script
**ProTip:** If you choose to host on [Now](www.now.sh), check `now secrets help`
**Note:** As of 15 November 2017, deploying on Now needs this workaround - [probot/probot#318](https://github.com/probot/probot/issues/318#issuecomment-343010573)
<!--
then
make sure to add `@triage-new-issues-app-id`, `@triage-new-issues-private-key`, `@triage-new-issues-webhook-secret` secrets and then you can use it [as in here](https://github.com/tunnckoCore/triage-new-issues/blob/e0e38f95d9e51cd65e39acb188847097115f2177/package.json#L23-L29). On more help of how to add secrets to [Now](www.now.sh) check `now secrets help`. -->
**[back to top](#thetop)**
## Related Projects
Some of these projects are used here or were inspiration for this one, others are just related. So, thanks for your existance!
- [execa](https://www.npmjs.com/package/execa): A better `child_process` | [homepage](https://github.com/sindresorhus/execa#readme "A better `child_process`")
- [gitcommit](https://www.npmjs.com/package/gitcommit): Simple, small and stable helper & prompter for submitting conventional commits | [homepage](https://github.com/tunnckoCore/gitcommit#readme "Simple, small and stable helper & prompter for submitting conventional commits")
- [hela](https://www.npmjs.com/package/hela): Powerful & flexible task runner framework in 80 lines, based on execa… [more](https://github.com/tunnckoCore/hela#readme) | [homepage](https://github.com/tunnckoCore/hela#readme "Powerful & flexible task runner framework in 80 lines, based on execa. Supports presets, a la ESLint but for tasks & npm scripts")
- [mri](https://www.npmjs.com/package/mri): Quickly scan for CLI flags and arguments | [homepage](https://github.com/lukeed/mri#readme "Quickly scan for CLI flags and arguments")
- [p-map-series](https://www.npmjs.com/package/p-map-series): Map over promises serially | [homepage](https://github.com/sindresorhus/p-map-series#readme "Map over promises serially")
**[back to top](#thetop)**
## Contributing
Please read the [Contributing Guide](./CONTRIBUTING.md) and [Code of Conduct](./CODE_OF_CONDUCT.md) documents for advices.
For bugs reports and feature requests, [please create an issue][open-issue-url] or join us at our [Flock chat][chat-url] rooms.
## Contributors
Thanks to the hard work of [these wonderful people](./CONTRIBUTORS.md) this project is alive and it also follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification.
[Pull requests](./CONTRIBUTING.md#opening-a-pull-request), stars and all kind of [contributions](https://opensource.guide/how-to-contribute/#what-it-means-to-contribute) are always welcome.
## Users
You can see who uses `triage-new-issues` in the [USERS.md](./USERS.md) file. Please feel free adding this file if it not exists.
If you or your organization are using this project, consider adding yourself to the list of users. **Thank You!**
## License
Copyright (c) 2017-present, [Charlike Mike Reagent][author-link] `<olsten.larck@gmail.com>`.
Released under the [Apache-2.0 License][license-url].
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on November 17, 2017._
_Project scaffolded and managed with [hela][]._
[hela]: https://github.com/tunnckoCore/hela
[probot]: https://github.com/probot/probot
<!-- Heading badges -->
[npmv-url]: https://www.npmjs.com/package/triage-new-issues
[npmv-img]: https://img.shields.io/npm/v/triage-new-issues.svg?label=npm%20version
[github-release-url]: https://github.com/tunnckoCore/triage-new-issues/releases/latest
[github-release-img]: https://img.shields.io/github/release/tunnckoCore/triage-new-issues.svg?label=github%20release
[license-url]: https://github.com/tunnckoCore/triage-new-issues/blob/master/LICENSE
[license-img]: https://img.shields.io/npm/l/triage-new-issues.svg
<!-- [license-img]: https://img.shields.io/badge/license-tunnckoCore_1%2E0-blue.svg -->
[downloads-monthly-img]: https://img.shields.io/npm/dm/triage-new-issues.svg
<!-- Front line badges -->
[bithound-score-url]: https://www.bithound.io/github/tunnckoCore/triage-new-issues
[bithound-score-img]: https://www.bithound.io/github/tunnckoCore/triage-new-issues/badges/score.svg
[bithound-code-url]: https://www.bithound.io/github/tunnckoCore/triage-new-issues
[bithound-code-img]: https://www.bithound.io/github/tunnckoCore/triage-new-issues/badges/code.svg
[standard-url]: https://github.com/airbnb/javascript
[standard-img]: https://img.shields.io/badge/code_style-airbnb-brightgreen.svg
[circleci-url]: https://circleci.com/gh/tunnckoCore/triage-new-issues/tree/master
[circleci-img]: https://img.shields.io/circleci/project/github/tunnckoCore/triage-new-issues/master.svg
[codecov-url]: https://codecov.io/gh/tunnckoCore/triage-new-issues
[codecov-img]: https://img.shields.io/codecov/c/github/tunnckoCore/triage-new-issues/master.svg
[bithound-deps-url]: https://www.bithound.io/github/tunnckoCore/triage-new-issues/dependencies/npm
[bithound-deps-img]: https://www.bithound.io/github/tunnckoCore/triage-new-issues/badges/dependencies.svg
[dependencies-url]: https://david-dm.org/tunnckoCore/triage-new-issues
[dependencies-img]: https://img.shields.io/david/tunnckoCore/triage-new-issues.svg
<!-- Second front of badges -->
[chat-url]: https://tunnckocore.flock.com/?i=cx2xoeofjtj6eo6c
[chat-img]: https://img.shields.io/badge/chat-on_flock-brightgreen.svg
[prettier-url]: https://github.com/prettier/prettier
[prettier-img]: https://img.shields.io/badge/styled_with-prettier-f952a5.svg
[nodesecurity-url]: https://nodesecurity.io/orgs/tunnckocore/projects/b39d4bd7-59d6-43fa-9e21-b2589b5169b4/master
[nodesecurity-img]: https://nodesecurity.io/orgs/tunnckocore/projects/b39d4bd7-59d6-43fa-9e21-b2589b5169b4/badge
<!-- the original color of nsp:
[nodesec-img]: https://img.shields.io/badge/nsp-no_known_vulns-35a9e0.svg -->
[ccommits-url]: https://conventionalcommits.org/
[ccommits-img]: https://img.shields.io/badge/conventional_commits-1.0.0-yellow.svg
[prs-welcome-img]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
[prs-welcome-url]: http://makeapullrequest.com
[nodeversion-url]: https://nodejs.org/en/download
[nodeversion-img]: https://img.shields.io/node/v/triage-new-issues.svg
[renovate-url]: https://renovateapp.com
[renovate-img]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg
<!-- Third badges line (After CodeSponsor ads) -->
[all-contributors-img]: https://img.shields.io/github/contributors/tunnckoCore/triage-new-issues.svg?label=all%20contributors&colorB=ffa500
[tinyletter-url]: https://tinyletter.com/tunnckoCore
[tinyletter-img]: https://img.shields.io/badge/join-newsletter-9caaf8.svg
[paypal-donate-url]: https://paypal.me/tunnckoCore/10
[paypal-donate-img]: https://img.shields.io/badge/$-support-f47721.svg
[downloads-weekly-img]: https://img.shields.io/npm/dw/triage-new-issues.svg
[downloads-total-img]: https://img.shields.io/npm/dt/triage-new-issues.svg
<!-- Miscellaneous -->
[share-love-url]: https://twitter.com/intent/tweet?text=https://github.com/tunnckoCore/triage-new-issues&via=tunnckoCore
[share-love-img]: https://img.shields.io/badge/share-love-1da1f2.svg
[open-issue-url]: https://github.com/tunnckoCore/triage-new-issues/issues/new
[highlighted-link]: https://ghub.now.sh/hela
[author-link]: https://i.am.charlike.online