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

Missing or extra line breaks in the Changelog unreleased section are retained in the new version-bumped section #149

Open
paulshryock opened this issue Jul 14, 2022 · 0 comments
Assignees
Labels
bug Something isn't working

Comments

@paulshryock
Copy link
Owner

paulshryock commented Jul 14, 2022

When there are missing or extra line breaks in the Unreleased section, those missing or extra new lines are retained in the version-bumped section after running Release Bump. They should be added and removed automatically to fix formatting.

Acceptance criteria

  1. Add missing new lines
    • GIVEN: There are missing new lines in the Unreleased section
    • WHEN: Release Bump is run
    • THEN: There are no missing new lines in the version-bumped section
  2. Remove extra new lines
    • GIVEN: There are extra new lines in the Unreleased section
    • WHEN: Release Bump is run
    • THEN: There are no extra new lines in the version-bumped section

Example

This:

## Unreleased

### Added
- Add something.
### Changed
- Changed something.
- Changed something else.


### Removed
- Removed something.

- Removed something else.

### Deprecated
### Fixed

### Security

Should become:

## [<version>] - <date>

### Added
- Add something.

### Changed
- Changed something.
- Changed something else.

### Removed
- Removed something.
- Removed something else.

Instead of:

## [<version>] - <date>

### Added
- Add something.
### Changed
- Changed something.
- Changed something else.


### Removed
- Removed something.

- Removed something else.
@paulshryock paulshryock changed the title Automatically add missing (and remove extra) line breaks from Changelog unreleased section Missing or extra line breaks in the Changelog unreleased section are retained in the new version-bumped section Jul 14, 2022
@paulshryock paulshryock added the bug Something isn't working label Jul 14, 2022
@paulshryock paulshryock self-assigned this Jul 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant