conventional-changelog / conventional-changelog/commitlint

feat: allow ignoring commits from certain users

Open
#3,666 2 comments 1 reaction 0 assignees View on GitHub
feature
Dominant language
TypeScript
Stars
18.7k
Forks
970
Avg merge
7h 33m
Merged PRs (30d)
49

Description

### Expected Behavior

Some commits are raised by bots or other scripts that may not necessarily pass strict rulesets. It should be possible to bypass linting commits by some specified users so that commits made by some automated process do not need to be manually fixed up.

### Current Behavior

It is only possible to ignore commits by the content of the messages.

### Affected packages

- [ ] cli
- [ ] core
- [ ] prompt
- [ ] config-angular

### Possible Solution

Extend the `ignores` config matcher to include additional metadata. For this use case only user is required but there may be other use cases:

```
ignores: [
(message, user) => user.includes('[bot]@users.noreply.github.com')
]
```

### Context

We use automated processes to upgrade pull requests, the commits raised in this way contain a URL that sometimes is longer than the maximum line length. Since these are automated we don't particularly care about perfect formatting so want to ignore any commits raised by bot users.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.