`@atomist/pr-commit-check-skill`

What it's useful for

Monitor the HEAD commit messages on any incoming pull requests. If they don't conform to a set of rules, then add a Comment, and create a failing github check to block merge of the pull request.

Skill users can control the Comment message sent when there are violations. The rules are based on regular expressions, and are added as Strings with the following pattern:

["^[a-z]" "The commit message should begin with a capital letter."]

The first String is the regular expression. If any part of the Commit message matches this regular expression, the skill will trigger a violation. The second string will be displayed in the pull request comment and the check failure.

Before you get started

GitHub

The GitHub integration must be configured in order to use this skill. At least one repository must be selected.

How to configure

Choose a message

Help users understand that their Commit message does not conform to guidelines. Use a simple message template like:
```
## Violations

%s

See [How to write a Git Commit Message](https://chris.beams.io/posts/git-commit/#seven-rules)
```
This supports markdown and the first %s encountered will be subsituted with a markdown array of violations that have been found in the message.
Choose Rules

Add regular expression rules. Each rule must conform to the pattern illustrated here:
```
["^[a-z]" "The commit message should begin with a capital letter."]
```
If any part of the message matches the regular expression, the violation will be triggered. The second display string is added to help users understand the violation. It can contain markdown.
Select repositories

By default, this skill will be enabled for all repositories in all organizations you have connected. To restrict the organizations or specific repositories on which the skill will run, you can explicitly choose organization(s) and repositories.

Either select all, if all your repositories should participate, or choose a subset of repositories that should stay have pull requests monitored.

How to Use

Configure the skill as described above
Commit and push your code changes
Skill will add Checks to pull requests with bad commit messages

Developing

Start a shadow-cljs watch process
```
npm run build:watch
```
Start up a Node environment
```
node index.js
```
Connect an nrepl session at .nrepl-port and switch to the Node environment using
```
=> (shadow/repl :dev)
```

Testing

npm run test

Releasing

We will register new versions of this skill whenever a Git annotated tag is pushed.

clj -Arelease patch

This will create a new version that can installed into a workspace using the url https://go.atomist.com/catalog/skills/atomist/pr-commit-check-skill?stability=unstable.

Join the pr-commit-check-skill Slack channel to see progress on releasing the Skill.

[unstable]: https://go.atomist.com/catalog/skills/atomist/pr-commit-check-skill?stability=unstable

Created by Atomist. Need Help? Join our Slack workspace.

atomist-skills / pr-commit-check-skill

readme