diffplug / diffplug/spotless-changelog

Fail a PR if it changes source code without a changelog entry

Open
#15 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Java
Stars
49
Forks
2
PR merge metrics
No merged PRs in 30d

Description

Spotless Changelog can handle the case where a single git repository has multiple changelogs for its various components. However, it can be easy to miss when a changelog which is mostly about component A, actually also brushes againt component B, and it can be bad if you forget to add a changelog for component B.

Perhaps we should implement something like the following:

```gradle
spotlessChangelog {
ifAnyFilesChangedIn('./lib/**/*', './lib-extra/**/*').since('origin/main').thenEntryRequired()
...
```

The snippet above could have avoided a problem [we had recently in spotless](https://github.com/diffplug/spotless/pull/706#issuecomment-703397058).

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.