Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2021-03-04 21:09:08 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2021-03-04 21:09:08 +0300
commit60bb1b9734536021c8eba9d15ac1a666af45be74 (patch)
tree237704d4183d19d3818fbb57c308add9f62ba3b5 /doc/api/repositories.md
parent770adf92515e4311dfb42d89750d32a1e0628913 (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/repositories.md')
-rw-r--r--doc/api/repositories.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/api/repositories.md b/doc/api/repositories.md
index 49a53039847..50dc0803646 100644
--- a/doc/api/repositories.md
+++ b/doc/api/repositories.md
@@ -395,6 +395,26 @@ these as the changelog entries. You can enrich entries with additional data,
such as a link to the merge request or details about the commit author. You can
[customize the format of a changelog](#customize-the-changelog-output) section with a template.
+### Reverted commits
+
+> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/55537) in GitLab 13.10.
+
+When generating a changelog for a range, GitLab ignores commits both added and
+reverted in that range. Revert commits themselves _are_ included if they use the
+Git trailer used for generating changelogs.
+
+Imagine the following scenario: you have three commits: A, B, and C. To generate
+changelogs, you use the default trailer `Changelog`. Both A and B use this
+trailer. Commit C is a commit that reverts commit B. When generating a changelog
+for this range, GitLab only includes commit A.
+
+Revert commits are detected by looking for commits where the message contains
+the pattern `This reverts commit SHA`, where `SHA` is the SHA of the commit that
+is reverted.
+
+If a revert commit includes the trailer used for generating changelogs
+(`Changelog` in the above example), the revert commit itself _is_ included.
+
### Customize the changelog output
The output is customized using a YAML configuration file stored in your