https://github.com/bkeepers/state
a state machine for GitHub Issues and Pull Requests
https://github.com/bkeepers/state
Last synced: 9 months ago
JSON representation
a state machine for GitHub Issues and Pull Requests
- Host: GitHub
- URL: https://github.com/bkeepers/state
- Owner: bkeepers
- License: isc
- Created: 2017-05-21T00:07:15.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-07-21T18:39:43.000Z (almost 9 years ago)
- Last Synced: 2025-01-12T02:05:02.982Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://github.com/apps/state
- Size: 12.7 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Probot: State
> a GitHub Integration built with [probot](https://github.com/probot/probot) that defines a state machine for GitHub Issues and Pull Requests
## Usage
1. **[Configure the GitHub Integration](https://github.com/integration/state)**
2. Create `.github/state.yml`
A `.github/state.yml` file is required to enable the plugin, and it must list the labels that are considered unique states:
```yml
states:
- bug
- enhancement
- question
# Name of project to update when state changes.
# This add Issues and Pull Requests to columns with the same name as the states.
project: Backlog
```
Whenever one of these labels are added to an Issue or Pull Request, it will remove labels for any of the other states.
## Development
```
# Install dependencies
npm install
# Run the bot
npm start
```
See [docs/deploy.md](docs/deploy.md) if you would like to run your own instance of this plugin.