Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enforce "types" of changes #1

Open
nedtwigg opened this issue Dec 4, 2019 · 0 comments
Open

Enforce "types" of changes #1

nedtwigg opened this issue Dec 4, 2019 · 0 comments
Labels
enhancement New feature or request

Comments

@nedtwigg
Copy link
Member

nedtwigg commented Dec 4, 2019

For 1.0, we scaled back our ambitions in this commit: ba6fa6b

Here is what we had been planning:

spotlessChangelog {
  types ['Added', 'Changed', 'Deprecated', 'Removed', 'Fixed', 'Security']	
  typesBumpMinor ['Added']
  typesBumpMajor ['Changed', 'Removed']	
}

I think a simple regex for minor and major version turns out to be easier to understand and works better than the type categories above. After all you can say ifFoundBumpMajor '### Changed', '### Removed' to get the same effect, so I'm against the typesBump concept because ifFound is strictly better.

Enforcing the spelling, set, and order of the tags seems useful, but only if it's not annoying. If it complains about the order but can't fix it with changelogApply, then that would be annoying.

Implementing this is very low-priority for us, but if anyone wants it for themselves, here is a test case it would need to pass:

## [Unreleased]

## [2.0.0] - yyyy-mm-dd

This release has a lot of breaking changes, but the reason is blah blah blah

### Added
...
### Removed
- some widget

<sup>1</sup> details on something from the addition block
<sup>2</sup> more details

## [1.0.0] - yyyy-mm-dd

It doesn't need to enforce the ordering, but if it does, it has to be able to reorder them too. If it's not implemented carefully, that reordering could be destructive, so you'll need to be careful and prove that the reordering is careful to get it merged.

@nedtwigg nedtwigg added the enhancement New feature or request label Dec 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant