Skip to content

(DOCUMENT-824) Update Changelog Format #264

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

Conversation

RandomNoun7
Copy link
Contributor

This commit updates the changelog format to the more standardized KAC
format: http://keepachangelog.com/en/1.0.0/
Ticket numbers were added to comments in the cases where they could be
found.

@RandomNoun7 RandomNoun7 force-pushed the tickets/master/DOCUMENT-824-update_changelog_to_kac branch from 679a060 to 8ac0c7e Compare February 27, 2018 19:55
CHANGELOG.md Outdated

### Changed

- Updated modulesync maintained files. Maint commit with no ticket.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update to present tense / imperative

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, don't need to specify maint commit / lack of ticket, same for other examples below.

CHANGELOG.md Outdated

### Changed

- Updated modulesync maintained files. Maint commit with no ticket.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, don't need to specify maint commit / lack of ticket, same for other examples below.

CHANGELOG.md Outdated
### Fixed

- Fix problem installing sql instance when an array of SQL Admins are specified. ([MODULES-6356](https://tickets.puppetlabs.com/browse/MODULES-6356))
- Fix AppVeyor OpenSSL bug. Maint commit with no ticket.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link to bug?

CHANGELOG.md Outdated
- Fix AppVeyor OpenSSL bug. Maint commit with no ticket.
- During acceptance testing, only execute master provisioning steps if there is
a master in the hosts array. Maint commit with no ticket.
- Stop running ```gem update bundler``` during Travis runs. Maint commit with no
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why? Link?

CHANGELOG.md Outdated

### Changed

- Updated modulesync maintained files. Maint commit with no ticket.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can probably leave off the Maint commit with no ticket lines.

@RandomNoun7 RandomNoun7 force-pushed the tickets/master/DOCUMENT-824-update_changelog_to_kac branch from 8ac0c7e to e38f421 Compare February 27, 2018 20:39
CHANGELOG.md Outdated

### Changed

- Update modulesync maintained files.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could probably drop this section, changelog is for users, not maintainers (we have the commit logs for that).

@RandomNoun7 RandomNoun7 force-pushed the tickets/master/DOCUMENT-824-update_changelog_to_kac branch from e38f421 to 950e8b1 Compare February 27, 2018 20:47
@RandomNoun7 RandomNoun7 reopened this Feb 27, 2018
@RandomNoun7 RandomNoun7 force-pushed the tickets/master/DOCUMENT-824-update_changelog_to_kac branch 2 times, most recently from 004eee0 to d565f4e Compare February 27, 2018 23:26
Copy link
Contributor

@jpogran jpogran left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need newline after each heading

CHANGELOG.md Outdated

## 2015-09-08 - Supported Release 1.1.0
### Changed
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there supposed to be two changed blocks here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, because this changed block is for 1.1.1 and the previous is for 1.1.2

CHANGELOG.md Outdated
- New `sqlserver_tsql` provider available to execute custom scripts.
- Remove dependency on 'sqlcmd.exe'.

### Changed
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

newline after changed needed

CHANGELOG.md Outdated
- Performance discovery improvements.

### Removed
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

newline after needed

@@ -1,123 +1,120 @@
## 2017-12-8 - Supported Release 2.1.0
# Changelog
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

newline after needed

@RandomNoun7 RandomNoun7 force-pushed the tickets/master/DOCUMENT-824-update_changelog_to_kac branch from d565f4e to 9cae585 Compare February 28, 2018 15:51
This commit updates the changelog format to the more standardized KAC
format: http://keepachangelog.com/en/1.0.0/
Ticket numbers were added to comments in the cases where they could be
found.
@RandomNoun7 RandomNoun7 force-pushed the tickets/master/DOCUMENT-824-update_changelog_to_kac branch from 9cae585 to 39ae96d Compare February 28, 2018 15:52
@jpogran jpogran merged commit dc2512a into puppetlabs:master Feb 28, 2018
@RandomNoun7 RandomNoun7 deleted the tickets/master/DOCUMENT-824-update_changelog_to_kac branch February 28, 2018 16:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants