From 96b7866f3516862ef0c4f54bf422d64780fae967 Mon Sep 17 00:00:00 2001 From: Patrick Bajao <ebajao@gitlab.com> Date: Thu, 16 Jul 2020 19:53:20 +0800 Subject: [PATCH] Document changelog as part of process Generating a changelog entry is now required when a merge request warrants a CHANGELOG entry. --- PROCESS.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/PROCESS.md b/PROCESS.md index 6fcf65a7afa8..d5dad2f0c346 100644 --- a/PROCESS.md +++ b/PROCESS.md @@ -10,6 +10,20 @@ GitLab-Workhorse has the following maintainers: This list is defined at https://about.gitlab.com/team/. +## Changelog + +GitLab-Workhorse keeps a changelog which is generated when a new release +is created. The changelog is generated from entries that are included on each +merge request. To generate an entry on your branch run: +`_support/changelog "Change descriptions"`. + +After the merge request is created, the ID of the merge request needs to be set +in the generated file. If you already know the merge request ID, run: +`_support/changelog -m <ID> "Change descriptions"`. + +Any new merge request must contain either a new entry or a justification in the +merge request description why no changelog entry is needed. + ## Merging and reviewing contributions Contributions must be reviewed by at least one Workhorse maintainer. -- GitLab