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-09-15 03:09:30 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2021-09-15 03:09:30 +0300
commitb754c00a217814cdf3fdaaa51e695a44095c0197 (patch)
tree7844f33736ea727a1e7a48a5e5c4585ab9161f28 /doc/api/repositories.md
parentfb8839a8cd34244622d6361f1a1f7e49265813d1 (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/repositories.md')
-rw-r--r--doc/api/repositories.md15
1 files changed, 11 insertions, 4 deletions
diff --git a/doc/api/repositories.md b/doc/api/repositories.md
index a669bb5177f..1c9136d22ac 100644
--- a/doc/api/repositories.md
+++ b/doc/api/repositories.md
@@ -448,6 +448,10 @@ You can set the following variables in this file:
- `template`: a custom template to use for generating the changelog data.
- `categories`: a hash that maps raw category names to the names to use in the
changelog.
+- `include_groups`: a list of group full paths containing users whose
+ contributions should be credited regardless of project membership. The user
+ generating the changelog must have access to each group or the members will
+ not be credited.
Using the default settings, generating a changelog results in a section along
the lines of the following:
@@ -508,7 +512,7 @@ follows:
{% each entries %}
- [{{ title }}]({{ commit.reference }})\
-{% if author.contributor %} by {{ author.reference }}{% end %}\
+{% if author.credit %} by {{ author.reference }}{% end %}\
{% if merge_request %} ([merge request]({{ merge_request.reference }})){% end %}
{% end %}
@@ -598,7 +602,7 @@ template: |
{% each entries %}
- [{{ title }}]({{ commit.reference }})\
- {% if author.contributor %} by {{ author.reference }}{% end %}
+ {% if author.credit %} by {{ author.reference }}{% end %}
{% end %}
@@ -634,8 +638,11 @@ In an entry, the following variables are available (here `foo.bar` means that
- `commit.trailers`: an object containing all the Git trailers that were present
in the commit body.
- `author.reference`: a reference to the commit author (for example, `@alice`).
-- `author.contributor`: a boolean set to `true` when the author is an external
- contributor, otherwise this is set to `false`.
+- `author.contributor`: a boolean set to `true` when the author is not a project
+ member, otherwise `false`.
+- `author.credit`: a boolean set to `true` when `author.contributor` is `true` or
+ when `include_groups` is configured, and the author is a member of one of the
+ groups.
- `merge_request.reference`: a reference to the merge request that first
introduced the change (for example, `gitlab-org/gitlab!50063`).