Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lswith/probot-require-label
A Probot that applies a label to issues and/or PRs that do not have any labels matching a regular expression
https://github.com/lswith/probot-require-label
probot probot-app
Last synced: 2 months ago
JSON representation
A Probot that applies a label to issues and/or PRs that do not have any labels matching a regular expression
- Host: GitHub
- URL: https://github.com/lswith/probot-require-label
- Owner: lswith
- License: mit
- Created: 2019-07-05T00:21:25.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T02:01:17.000Z (almost 2 years ago)
- Last Synced: 2024-09-26T20:46:27.753Z (3 months ago)
- Topics: probot, probot-app
- Language: TypeScript
- Size: 1.91 MB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Require Label Bot
[![Downloads][npm-downloads]][npm-url] [![version][npm-version]][npm-url]
[![Build Status][travis-status]][travis-url]
A [Probot](https://probot.github.io) bot to make sure that a given label is added
to specific issues and pull requests when all other labels do not match a regex.
## Setup
Add a `.github/relabel.yml` file to your repository and then run the bot against it.
If the config is empty or doesn't exist, the bot will not run.
```yml
# This example configuration will add the `needs-area` and `needs-type` labels
# to any new issue and pull request that do not have labels matching `area:.*` or `type:.*`.
# Once the issue or the pull request has the `area:.....` label added the `needs-area` label will be
# removed from the issue or pull request.
issues:
# The missing label which will be added to issues if the regex doesn't match any other labels
- missingLabel: needs-area
regex: area:.*
- missingLabel: needs-type
regex: type:.*
pulls:
# The missing label which will be added to pull requests if the regex doesn't match any other labels
- missingLabel: needs-area
regex: area:.*
- missingLabel: needs-type
regex: type:.*
```
### Backwards compatibility
Previous version of the bot will still work with current version, as the schema for the configuration file does not change the structure. So it's possible to upgrade and keep old configuration:
```yaml
# The old format matches the new one, using a different name
requiredLabels:
- missingLabel: needs-area
regex: area:.*
- missingLabel: needs-type
regex: type:.*
```
## Contribute
If you have suggestions for how this bot could be improved, or want to report a bug, open an issue! We'd love all and any contributions.
[travis-status]: https://travis-ci.org/lswith/probot-require-label.svg?branch=master
[travis-url]: https://travis-ci.org/lswith/probot-require-label
[npm-downloads]: https://img.shields.io/npm/dm/probot-require-label.svg?style=flat
[npm-version]: https://img.shields.io/npm/v/probot-require-label.svg?style=flat
[npm-url]: https://www.npmjs.com/package/probot-require-label