Skip to content

Remove commit templates variable placeholders from settings

Piotr Stankowski requested to merge trakos/gitlab:merge-commit-template-remove-placeholders into master

What does this MR do and why?

Solves #349193 (closed).

This MR removes variable placeholders listed below "merge suggestions", "merge commit message template" and "squash commit message template" in project settings.

Those fields have both link to docs and list of all possible variable placeholders allowed to be used in commit template. You can see it on the screenshot below.

In a discussion !76042 (comment 793219061) @aqualls pointed out that after adding more variables we should consider removing the placeholders list.

I think that's a good idea, since user has to go to docs to make sense of what the variables actually do anyway. The list is not that useful on its own. You can see on the screenshot that this area of settings got a bit "crowded" visually.

The counter argument is that it's easier to copy variables when having it right next to form fields, but I think that opening the help link in a new tab isn't that much harder.

Screenshots or screen recordings

Before:

image

After:

image

Note that I've also changed the documentation link text (discussion: !77350 (comment 796840593) and !77350 (comment 800707805)) and moved help links below the field (comment: !77350 (comment 798265838)).

By the way, the change is more noticeable in mobile - before:

image

After:

image

How to set up and validate locally

  1. On the top bar, select Menu > Projects and find your project.
  2. On the left sidebar, select Settings > General and expand Merge requests.
  3. Verify the look of "Merge suggestions", "Merge commit message template" and "Squash commit message template" form fields.

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Edited by Piotr Stankowski

Merge request reports