Skip to content

See also my notes on GitLab and Work notes LWP: GitLab.

Table of Contents

TOC

To automatically create a table of contents for a page just add the following line

1
[[_TOC_]]

See also presentation on GitLab

Issues and Merge Requests🔗

New Issue or Merge Request🔗


graph LR
  ni["<b>New Issue/MR</b><div style='text-align: left;'>From previous? Template?</br>Relevant info, link related</br>To-Dos and <em>Tasks</em></br>Label, assign, prioritise</br>Prioritise and schedule</br></div><em>Ready</em></br>&nbsp;"]
  --> ci["<b>Working on Issue/MR</b><div style='text-align: left'>and <em>update</em></div><em>In Progress</em></br>&nbsp;"]
  --> cc["<b>Close Issue/MR</b><div style='text-align: left;'>Review</br>Remaining To-Dos? New issue/MR?</br>(Announce 'problem solved')</br>update other systems</br></div>Close issue</br>&nbsp;"]
  -->|"refine, link,</br>archive"| kms[(KMS)]

See notes on Mermaid graphs for reference.

Templates🔗

  • issues and merge requests
  • in projects, groups or instance with downward inheritance
  • example: guidelines for description, checklist with mandatory tests
  • .md extension, in .gitlab/{issue_templates,merge_request_templates} directories on default branch
  • GitLab uses Default.md as default, MR variables only work in this template

Merge Requests🔗

If WIP mark it as draft by ticking the checkbox or start title with Draft:.

Review🔗

In the Changes section GitLab offers a great tool for WIP MRs and collaboration. Changes to the code are shown as diffs with respect to the reference branch and there’s a feature to discuss changes and collaborate on solutions.

Linking/referencing Items🔗

For an issue on the same project the shorthand #... with the issue number works. Starting to type # gives a list of issues.

The same works with MRs by using !.... This will also show the MR status (e.g. merged).

To link items from a different project use group/project/... followed by the issue or MR reference or copy the whole URL.

To link issues and merge requests the most benefits are achieved by mentioning an issue in a merge request description. This will create an entry Related Merge Requests on the issue and show up in the MR activity.

See also presentation on GitLab.

Issue Boards🔗

Markdown and HTML🔗

Commenting: <!-- ... -->

1
2
<!-- This is a
comment -->

Embed images

1
2
3
4
<!-- since version 15.7 GitLab supports attributesin Markdown-esk syntax-->
![test](http://trekmovie.com/wp-content/uploads/2017/03/facepalm-head.jpg){width=20%}
<!-- HTML also works, but style attributes don't -->
<img src="..." width="50%">

GitLab Webinterface🔗

Labels🔗

See GitLab documentation.

Labels can be created for groups or projects and are useful to categorise issues, merge requests, etc.

Start typing ~ for available labels, for example ~"In progress" ~Ready ~Blocked. Use double ticks for labels with spaces, e.g. ~"In progress". This will render as

In Progress
Ready
Blocked

With GitLab EE labels ass scoped labels, for example to designate a team.

Emojis🔗

Start typing : to get suggestions/a search

  • 🚧 WIP: :construction:
  • ⚙ running: :gear:
  • ❌ error: :x:
  • ✅ successful: :white_check_mark:

Icons🔗

Gitlab SVG icons

  • Wiki:

    • local (Wiki):
    1
    ![](/GitLab/book.svg)
    • remote (issue/MR):
    1
    ![](https://gitlab.com/gitlab-org/gitlab-svgs/-/raw/main/sprite_icons/book.svg)

  • Issue:

    • local (Wiki):
    1
    ![](/GitLab/issues.svg)
    • remote (issue/MR):
    1
    ![](https://gitlab.com/gitlab-org/gitlab-svgs/-/raw/main/sprite_icons/issues.svg)

  • Open Merge Request:

    • local (Wiki):
    1
    ![](/GitLab/merge-request.svg)
    • remote (issue/MR):
    1
    ![](https://gitlab.com/gitlab-org/gitlab-svgs/-/raw/main/sprite_icons/merge-request.svg)

  • Merged Merge Request:

    • local (Wiki):
    1
    ![](/GitLab/merge.svg)
    • remote (issue/MR):
    1
    ![](https://gitlab.com/gitlab-org/gitlab-svgs/-/raw/main/sprite_icons/merge.svg)

CI/CD🔗

By default file .gitlab-ci.yml

GitLab CI/CD Documentation

Wiki🔗

GitLab CE doesn’t allow for group Wikis. The GitLab Wiki Webinterface is very limited. The only way to browse pages is by manually creating references, for example on a and in the sidebar. The latter is the same for any page visited, so a fairly good place to have a general table of contents. It is reommenced to edit and view the Wiki with external tools such as obsidian.

Activity🔗

See for example presentation on GitLab

Miscellaneous🔗

For more (obscure) features of GitLab see presentation on GitLab