This repository was archived by the owner on Apr 1, 2020. It is now read-only.
File tree Expand file tree Collapse file tree 2 files changed +4
-11
lines changed Expand file tree Collapse file tree 2 files changed +4
-11
lines changed Original file line number Diff line number Diff line change 1
- <a target =' _blank ' rel =' nofollow ' href =' https://app.codesponsor.io/link/yF8xMRYKxBs3t9VeMWabeRrx/ahmed-taj/commitlint-bot ' >
2
- <img alt =' Sponsor ' width =' 888 ' height =' 68 ' src =' https://app.codesponsor.io/embed/yF8xMRYKxBs3t9VeMWabeRrx/ahmed-taj/commitlint-bot.svg ' />
3
- </a >
4
-
5
- # commitlint-bot
1
+ # commitlint [ bot]
6
2
7
3
[ ![ Travis] ( https://img.shields.io/travis/ahmed-taj/commitlint-bot.svg )] ( https://travis-ci.org/ahmed-taj/commitlint-bot )
8
4
[ ![ npm] ( https://img.shields.io/npm/v/commitlint-bot.svg )] ( https://www.npmjs.com/package/commitlint-bot )
9
5
10
-
11
6
<p align =" center " >
12
7
<img src =" docs/robot.svg " width =" 256 " alt =" commitlint logo " />
13
8
</p >
14
9
15
10
> Built with [ probot] ( https://github.com/probot/probot ) framework
16
11
17
- A GitHub App that runs [ commitlint] ( https://github.com/marionebl/commitlint ) over all commits of new or edited pull requests
12
+ A GitHub App that runs [ commitlint] ( https://github.com/marionebl/commitlint ) against all commits of new or edited pull requests
18
13
and sets an appropriate status check.
19
14
20
15
## Usage
@@ -31,7 +26,6 @@ Problem details will be reported as a comment like this:
31
26
32
27
![ status-comment-screenshot] [ ]
33
28
34
-
35
29
For best results, enable branch protection (in the repository's settings) and require the ` commitlint ` status check to pass before merging:
36
30
37
31
![ branch-protection-screenshot] [ ]
@@ -60,8 +54,7 @@ npm install
60
54
4 . Start the app with ` APP_ID=1234 npm start ` where ` 1234 ` is your GitHub app's ID
61
55
5 . Update your GitHub app's Webhook URL to your localtunnel.me URL
62
56
63
- [ GitHub app ] : https://probot.github.io/docs/development/#configure-a-github-app
64
-
57
+ [ github app ] : https://probot.github.io/docs/development/#configure-a-github-app
65
58
66
59
## Credits
67
60
Original file line number Diff line number Diff line change @@ -6,7 +6,7 @@ const config = require('./config')
6
6
const format = require ( './format' )
7
7
8
8
/**
9
- * Runs commitlint over all commits of the pull request and sets an appropriate
9
+ * Runs commitlint against all commits of the pull request and sets an appropriate
10
10
* status check
11
11
*/
12
12
const commitlint = async ( { github, payload } ) => {
You can’t perform that action at this time.
0 commit comments