ChangeLog

To avoid the merge conflict on the ChangeLog file, we introduced in Stork an experimental way to update this file. The ChangeLog entry related to a particular merge request is no longer added directly to the ChangeLog file. Instead of it, the changelog note should be saved in a new file in the changelog_unreleased/ directory. The name of the file should include the GitLab issue number to ensure the filename is unique for all merge requests. The content of the file should omit the entry number. The format is:

[{category}]{* if the changes are backward incompatible}        {author}
    {multi-line description, indented}
    {GL issue number, indented}
{empty line}

The category must be surrounded by square brackets. The list of categories is available in the ChangeLog file. The backward incompatible change is marked by an asterisk. The author may contain multiple names delimited by a comma followed by a space.

The GitLab issue number must be constructed as follows:

(Gitlab #XXXX)

where XXXX is the GitLab issue number. Example:

[build]     slawek
    Changed the convention of preparing the ChangeLog file to avoid merge
    request conflicts on this file.
    (Gitlab #3522)

The entries are merged on release by the kea/build/prepare_kea_release.sh script available in the QA repository that is usually used in the release process. The release engineer commits the updated ChangeLog file (with the merged unreleased entries) and deletes content of the changelog_unreleased directory.