https://github.com/cchantep/probot-pr-status-label
🤖 Probot app that sets pull request statuses according labels
https://github.com/cchantep/probot-pr-status-label
github-action probot-app pull-request typescript
Last synced: about 1 year ago
JSON representation
🤖 Probot app that sets pull request statuses according labels
- Host: GitHub
- URL: https://github.com/cchantep/probot-pr-status-label
- Owner: cchantep
- License: isc
- Created: 2019-04-22T19:16:08.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2021-08-02T05:58:30.000Z (almost 5 years ago)
- Last Synced: 2025-03-18T19:51:53.836Z (about 1 year ago)
- Topics: github-action, probot-app, pull-request, typescript
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/pr-status-label
- Size: 26.5 MB
- Stars: 7
- Watchers: 1
- Forks: 4
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# pr-status-label
A GitHub App built with [Probot](https://github.com/probot/probot) that sets pull request statuses according labels.
## Usage
Add a label matching a status expression (see [*Configuration*](#configuration); e.g. ':ok_hand: review:ok').
### Configuration
On repository for which the application is installed,
a file named [`pr-status-label.json`](./src/resources/pr-status-label.json) can be defined on the base branches, in a `.github` directory at root. Default:
```json
{
"requiredStatusRegex": "^:[^:]+: ([^:]+):required$",
"pendingStatusRegex": "^:[^:]+: ([^:]+):pending$",
"successStatusRegex": "^:[^:]+: ([^:]+):(?:ok|success)$",
"errorStatusRegex": "^:[^:]+: ([^:]+):(ko|error)$"
}
```
- `requiredStatusRegex": Detects a label as a required status (like `pending` but before any action).
- `pendingStatusRegex`: Detects a label as a pending status (e.g. `:eyes: review:pending`).
- `successStatusRegex`: Detects a label as a success status; Starts with an emoji code, followed after a space by a status (capture group), and finally after a `:` separator either `ok` or `success` (e.g. `:ok_hand: review:ok`).
- `errorStatusRegex`: Detects a label as an error (e.g. `:flushed: review:ko`)
### GitHub Actions
To use this bot with [GitHub Actions](https://github.com/features/actions), the following workflow can be defined as `.github/workflows/pr-status-label.yml` in your repository.
```
name: PR status label
on
pull_request:
types: ['labeled', 'synchronize']
jobs:
check_pr_milestone:
runs-on: ubuntu-latest
steps:
- uses: cchantep/probot-pr-status-label@ghaction-1.0.x
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
## Build
```sh
# Install dependencies
npm install
# Run typescript
npm run build
# Run the bot
npm start
```
[](https://circleci.com/gh/cchantep/probot-pr-status-label)
## Contributing
If you have suggestions for how pr-status-label could be improved, or want to report a bug, open an issue! We'd love all and any contributions.
For more, check out the [Contributing Guide](CONTRIBUTING.md).
## License
[ISC](LICENSE) © 2019 [Cédric Chantepie](https://github.com/cchantep/probot-pr-status-label)