ChangeLog: Add a ChangeLog for Mbed Crypto #150

Closed

Patater wants to merge 1 commit from crypto-changelog-is-back into development

Patater commented

2019-06-18 07:18:35 -05:00

(Migrated from github.com)

The commit messages are not clear enough when something is worthy of
mention in the release notes. Re-add a ChangeLog file for Mbed Crypto,
with a different name from the Mbed TLS ChangeLog, to enable easier
merging from Mbed TLS to Mbed Crypto (for things like shared tool
updates).

The commit messages are not clear enough when something is worthy of mention in the release notes. Re-add a ChangeLog file for Mbed Crypto, with a different name from the Mbed TLS ChangeLog, to enable easier merging from Mbed TLS to Mbed Crypto (for things like shared tool updates).

gilles-peskine-arm commented

2019-06-18 07:47:27 -05:00

(Migrated from github.com)

If we're going to use a different changelog format, let's switch to one that doesn't result in merge conflicts. Some projects such as Gitlab have switched to one entry per file, collected into a consolidated file when you make a release. How about doing this?

If you're going to use the same structure as the Mbed TLS changelog, please use the same format. Making the changelog look marginally nicer when viewed through an interface that renders markdown isn't worth the added burden of coping with two different formats. If we're going to use a different changelog format, let's switch to one that doesn't result in merge conflicts. Some projects such as [Gitlab](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/development/changelog.md) have switched to one entry per file, collected into a consolidated file when you make a release. How about doing this?

Patater commented

2019-06-18 08:03:05 -05:00

(Migrated from github.com)

We can change the format because we don't expect to copy paste between the two ChangeLogs. This file even has a different name so no merges will happen between the two projects on accident. The only thing we could copy paste between ChangeLogs are tools changes (e.g. new feature in ABI checker), but we generally don't put those into ChangeLogs.

Patater commented

2019-06-18 08:03:51 -05:00

(Migrated from github.com)

The move to markdown was to make turning a ChangeLog into release notes as easy as a copy paste, since release notes are markdown format already.

Patater commented

2019-06-18 08:05:21 -05:00

(Migrated from github.com)

Looking at GitLab, "one file per entry, and then compiling the entries into the overall CHANGELOG.md file during the release process." sounds good to me.

Patater commented

2019-09-04 04:15:57 -05:00

(Migrated from github.com)