diff options
| author | Zeger-Jan van de Weg <git@zjvandeweg.nl> | 2019-03-01 13:01:52 +0300 |
|---|---|---|
| committer | Zeger-Jan van de Weg <git@zjvandeweg.nl> | 2019-03-01 13:38:00 +0300 |
| commit | c9abaccd386584f783014611e641acfd82f716eb (patch) | |
| tree | 08b10cedd8fd97167052616e228fe3d32d88b069 | |
| parent | acdb4147d57ac1517363f8b1455ee06cce2dfc8f (diff) | |
Fix missing SEE_DOC constant in Danger
Spotted on a MR where I was missing a MR ID, I removed a constant
which was required and used. By reintroducing the constant Danger should
work correctly again.
The docs had to link somewhere, so this change adds documentation too.
| -rw-r--r-- | CONTRIBUTING.md | 24 | ||||
| -rw-r--r-- | changelogs/unreleased/zj-fix-see-doc-danger.yml | 5 | ||||
| -rw-r--r-- | danger/changelog/Dangerfile | 1 |
3 files changed, 20 insertions, 10 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2d6d1288e..38239d9d6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,27 +46,31 @@ The Gitaly style guide is [documented in it's own file](STYLE.md). ## Changelog -Any new merge request must contain either a CHANGELOG.md entry or a -justification why no changelog entry is needed. New changelog entries -should be added to the **top** of the 'UNRELEASED' section of CHANGELOG.md. +Gitaly keeps a [changelog](CHANGELOG.md) 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. If a change is specific to an RPC, start the changelog line with the RPC name. So for a change to RPC `FooBar` you would get: > FooBar: Add support for `fluffy_bunnies` parameter -## GitLab CE changelog - -We only create GitLab CE changelog entries for two types of merge request: - -- adding a feature flag for one or more Gitaly RPC's (meaning the RPC becomes available for trials) -- removing a feature flag for one or more Gitaly RPC's (meaning everybody is using a given RPC from that point on) - ## Gitaly Maintainers | Maintainer | |--------------------| |@jacobvosmaer-gitlab| +|@zj | +|@pokstad1 | +|@johncai | ## Development Process diff --git a/changelogs/unreleased/zj-fix-see-doc-danger.yml b/changelogs/unreleased/zj-fix-see-doc-danger.yml new file mode 100644 index 000000000..b9d92686f --- /dev/null +++ b/changelogs/unreleased/zj-fix-see-doc-danger.yml @@ -0,0 +1,5 @@ +--- +title: Fix missing SEE_DOC constant in Danger +merge_request: 1109 +author: +type: fixed diff --git a/danger/changelog/Dangerfile b/danger/changelog/Dangerfile index af8e6b93d..95e23e246 100644 --- a/danger/changelog/Dangerfile +++ b/danger/changelog/Dangerfile @@ -1,6 +1,7 @@ require 'yaml' NO_CHANGELOG_LABELS = %w[backstage Documentation test].freeze +SEE_DOC = "See [the documentation](https://gitlab.com/gitlab-org/gitaly/blob/master/CONTRIBUTING.md#changelog)".freeze CREATE_CHANGELOG_MESSAGE = <<~MSG.freeze You can create one with: |