kylefang/probot.github.io
1
0
Fork 0
mirror of https://github.com/zhigang1992/probot.github.io.git synced 2026-01-12 22:49:53 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add validate-commit-msg-bot app

Browse Source 
Adds an app template for validate-commit-msg-bot.

Closes https://github.com/tlvince/validate-commit-msg-bot/issues/4.
This commit is contained in:
Tom Vincent
2017-09-25 10:59:18 +01:00
committed by GitHub
parent f1953120dc
commit cd0e2d4b09
1 changed files with 47 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
validate-commit-msg-bot.md Normal file
View File

@@ -0,0 +1,47 @@
---
title: validate-commit-msg-bot
description: Runs validate-commit-msg over all commits of new or edited pull requests and sets an appropriate a status check.
slug: validate-commit-msg-bot
screenshots:
- https://github.com/tlvince/validate-commit-msg-bot/raw/master/docs/status-check-screenshot.png
authors: [ tlvince ]
repository: tlvince/validate-commit-msg-bot
---
> validate-commit-msg aaS
Runs [validate-commit-msg][] over all commits of new or edited pull requests and sets an appropriate a [status check][].
Send a PR to [tlvince-sandbox-validate-commit-msg-bot][] to see it in action.
[status check]: https://developer.github.com/v3/repos/statuses/
[validate-commit-msg]: https://github.com/conventional-changelog/validate-commit-msg
[tlvince-sandbox-validate-commit-msg-bot]: https://github.com/tlvince/tlvince-sandbox-validate-commit-msg-bot
## Usage
1. Browse to [GitHub Apps - validate commit msg][apps]
2. Accept the permissions
3. Allow access to repositories
On the next pull request, a status check from `validate-commit-msg-bot` will appear:
![status-check-screenshot][]
For best results, enable branch protection (in the repository's settings) and require the `validate-commit-msg` status check to pass before merging:
![branch-protection-screenshot][]
[apps]: https://github.com/apps/validate-commit-msg-bot
[status-check-screenshot]: https://raw.githubusercontent.com/tlvince/validate-commit-msg-bot/master/docs/status-check-screenshot.png
[branch-protection-screenshot]: https://raw.githubusercontent.com/tlvince/validate-commit-msg-bot/master/docs/branch-protection-screenshot.png
## Author
© 2017 Tom Vincent <git@tlvince.com> (https://tlvince.com)
## License
Released under the [MIT license](http://tlvince.mit-license.org).
Robot emoji courtesy of [EmojiOne](https://www.emojione.com/emoji/1f916).