From 5bc18e40fd80d2c46b87dea69e7d21ed3275ad60 Mon Sep 17 00:00:00 2001 From: Mayra Cabrera <mcabrera@gitlab.com> Date: Thu, 27 May 2021 09:38:11 -0500 Subject: [PATCH] Restore changelog requirements The new changelog workflow has been rolled out, while we no longer require changelog entries in 'changelogs/unreleased' we still require some MRs to provide changelog messages using the new workflow. This commits restores the mandatory changelog rules. --- doc/development/changelog.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/doc/development/changelog.md b/doc/development/changelog.md index 8e7b9868cbed3..616b175c9ebc9 100644 --- a/doc/development/changelog.md +++ b/doc/development/changelog.md @@ -79,8 +79,17 @@ EE: true ## What warrants a changelog entry? -- Any user-facing change **should** have a changelog entry. Example: "GitLab now +- Any change that introduces a database migration, whether it's regular, post, + or data migration, **must** have a changelog entry, even if it is behind a + disabled feature flag. +- [Security fixes](https://gitlab.com/gitlab-org/release/docs/blob/master/general/security/developer.md) + **must** have a changelog entry, with `Changelog` trailer set to `security`. +- Any user-facing change **must** have a changelog entry. Example: "GitLab now uses system fonts for all text." +- Any client-facing change to our REST and GraphQL APIs **must** have a changelog entry. + See the [complete list what comprises a GraphQL breaking change](api_graphql_styleguide.md#breaking-changes). +- Any change that introduces an [Advanced Search migration](elasticsearch.md#creating-a-new-advanced-search-migration) + **must** have a changelog entry. - A fix for a regression introduced and then fixed in the same release (such as fixing a bug introduced during a monthly release candidate) **should not** have a changelog entry. -- GitLab