https://github.com/behaviorbot/update-docs
Prompts users to include documentation in pull requests
https://github.com/behaviorbot/update-docs
github-app probot probot-app
Last synced: 3 months ago
JSON representation
Prompts users to include documentation in pull requests
- Host: GitHub
- URL: https://github.com/behaviorbot/update-docs
- Owner: behaviorbot
- License: mit
- Created: 2017-07-12T18:29:50.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-10-17T22:02:17.000Z (over 6 years ago)
- Last Synced: 2024-09-27T08:02:24.943Z (8 months ago)
- Topics: github-app, probot, probot-app
- Language: JavaScript
- Homepage: https://github.com/apps/update-docs
- Size: 98.6 KB
- Stars: 32
- Watchers: 5
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# update-docs
> a GitHub App built with [probot](https://github.com/probot/probot) that comments on newly opened Pull Requests that do not update either the README or a file in the `/docs` folder.
## Usage
1. Install the bot on the intended repositories. The plugin requires the following **Permissions and Events**:
- Pull requests: **Read & Write**
- [x] check the box for **Pull Request** events
2. Add a `.github/config.yml` file that contains the contents you would like to reply within an `updateDocsComment`
3. Optionally, you can also add a `whiteList` that includes terms, that if found in the title, the bot will not comment on.
4. Optionally, you can also add `targetFiles` that includes the files or paths to consider documentation.
```yml
# Configuration for update-docs - https://github.com/behaviorbot/update-docs
# Comment to be posted to on PRs that don't update documentation
updateDocsComment: >
Thanks for opening this pull request! The maintainers of this repository would appreciate it if you would update some of our documentation based on your changes.
updateDocsWhiteList:
- bug
- chore
updateDocsTargetFiles:
- README
- docs/
```
## Setup
```
# Install dependencies
npm install
# Run the bot
npm start
```
See [the probot deployment docs](https://github.com/probot/probot/blob/master/docs/deployment.md) if you would like to run your own instance of this plugin.