Skip to content

Use 'General Change.md' as default MR description

Mitchell Nielsen requested to merge docs-default-mr-template into master

What does this MR do?

Use 'General Change.md' as default MR description

Renames 'General Change.md' to 'Default.md' so it is automatically
used as the default merge request description.

Related documentation:
https://docs.gitlab.com/ee/user/project/description_templates.html#supported-variables-in-merge-request-templates

This ensures that the '%{first_multiline_commit}' variable works as
expected, given the note in the documentation:

> This feature is available only for the default template.

The [default template docs](https://docs.gitlab.com/ee/user/project/description_templates.html#set-a-default-template-for-merge-requests-and-issues)
state that the file needs to be named 'Default.md' (case insensitive).

Checklist

See Definition of done.

For anything in this list which will not be completed, please provide a reason in the MR discussion.

Required

  • Merge Request Title and Description are up to date, accurate, and descriptive
  • MR targeting the appropriate branch
  • MR has a green pipeline on GitLab.com
  • When ready for review, MR is labeled "~workflow::ready for review" per the Distribution MR workflow
  • (after merge) Remove the manually-entered default merge request description under Settings > Merge Requests > Default description template for merge requests

Expected (please provide an explanation if not completing)

  • Test plan indicating conditions for success has been posted and passes
  • Documentation created/updated
  • Tests added
  • Integration tests added to GitLab QA
  • Equivalent MR/issue for omnibus-gitlab opened
  • Validate potential values for new configuration settings. Formats such as integer 10, duration 10s, URI scheme://user:passwd@host:port may require quotation or other special handling when rendered in a template and written to a configuration file.
Edited by Mitchell Nielsen

Merge request reports