Upgrade & Secure Your Future with DevOps, SRE, DevSecOps, MLOps!

We spend hours scrolling social media and waste money on things we forget, but won’t spend 30 minutes a day earning certifications that can change our lives.
Master in DevOps, SRE, DevSecOps & MLOps by DevOpsSchool!

Learn from Guru Rajesh Kumar and double your salary in just one year.


Get Started Now!

GitLab Reference & Linking Guide such users, commits etc

Here’s a comprehensive GitLab reference guide on how to link, reference, and organize various entities (like issues, jobs, users, environments, etc.) across GitLab descriptions, wikis, commit messages, MRs, and more.


📘 GitLab Reference & Linking Guide (v18.x compatible)

GitLab provides Markdown and keyword-based shortcuts to cross-reference nearly every object in the system for traceability, collaboration, and automation.


1. Issues

🔹 Where to Reference

  • Commit messages: Fixes #123
  • Merge Request description: Closes #123
  • Comments, Wiki, Readme: #123

🔹 Format

#123              // Just refers to issue
Fixes #123        // Closes on merge
See issue #123    // Mentions without closing
Code language: PHP (php)

2. Merge Requests (MRs)

🔹 Where to Reference

  • Wiki: !45
  • Issues, Comments: See !45
  • Commit Messages (rare)

🔹 Format

!45
See merge request !45

3. Commits

🔹 Where to Reference

  • Issues, MRs: abcd1234 or project@abcd1234

🔹 Format

abcd1234              // Short SHA
project@abcd1234      // Cross-project
Code language: JavaScript (javascript)

4. Jobs (CI/CD)

🔹 Where to Reference

  • Pipeline tab or job logs in UI (not Markdown-accessible)
  • Use direct links or job artifacts in comments or wiki

🔹 Format (Manual linking)

[View Job Log](https://gitlab.com/namespace/project/-/jobs/123456789)
Code language: JavaScript (javascript)

5. Milestones

🔹 Where to Reference

  • Issues, MRs, Wiki: %milestone_name

🔹 Format

%v1.0
Targeted for %Q2-Release
Code language: CSS (css)

6. Requirements (GitLab Ultimate)

🔹 Where to Reference

  • Issues, MRs, Descriptions, Wiki: REQ-1, requirements#123

🔹 Format

Relates to requirements#12
Code language: CSS (css)

Enabled under Requirements Management in project settings.


7. Users

🔹 Where to Mention

  • Any Markdown-supported field: descriptions, comments, commit messages

🔹 Format

@username
Assigned to @john_doe
Code language: CSS (css)

8. Labels

🔹 Where to Use

  • Issue or MR references: ~"bug" or ~bug

🔹 Format

~"feature"
~backend
Code language: JavaScript (javascript)

9. Environments (CI/CD)

🔹 Where to Reference

  • Pipeline views, API, job logs

🔹 Format

[View Staging](https://gitlab.com/namespace/project/-/environments/123)
Code language: JavaScript (javascript)

10. Epics (GitLab Premium+)

🔹 Where to Reference

  • Issues, MRs, descriptions, comments: &123

🔹 Format

Part of epic &45

11. Snippets

🔹 Where to Reference

  • Wiki, comments: $snippet_id

🔹 Format

$42

12. Wiki Pages

🔹 Where to Reference

  • Markdown everywhere

🔹 Format

[Deployment Guide](../wikis/deployment)

13. Projects

🔹 Cross-project linking:

group/project#123         // Issue
group/project!456         // MR
group/project@SHA         // Commit
Code language: PHP (php)

14. Pipeline Status Badges

[![pipeline status](https://gitlab.com/group/project/badges/main/pipeline.svg)](https://gitlab.com/group/project/pipelines)
Code language: JSON / JSON with Comments (json)

📌 Markdown Reference Shortcuts Summary

Reference TypeSyntax ExampleDescription
Issue#123Links to issue
Merge Request!45Links to MR
Commitabcd1234Links to commit
Milestone%v1.0Links to milestone
Label~bugLinks to label
User@usernameMentions user
Epic&12Links to epic (Premium+)
Requirementrequirements#123Links to requirement (Ultimate)
Snippet$42Links to code snippet
Environment LinkDirect URLLink to job/env logs
Cross-projectgroup/project#123Ref to other repo issue/MR

🧠 Tips

  • GitLab autolinks most entities with typeahead autocomplete when typing @, #, !, etc.
  • Use templates (issue/MR/wikis) to enforce referencing conventions.
  • Use custom sections in MRs like: ### Linked Issues Fixes #123 ### Related MRs See !45

Subscribe
Notify of
guest
0 Comments
Newest
Oldest Most Voted
Inline Feedbacks
View all comments

Certification Courses

DevOpsSchool has introduced a series of professional certification courses designed to enhance your skills and expertise in cutting-edge technologies and methodologies. Whether you are aiming to excel in development, security, or operations, these certifications provide a comprehensive learning experience. Explore the following programs:

DevOps Certification, SRE Certification, and DevSecOps Certification by DevOpsSchool

Explore our DevOps Certification, SRE Certification, and DevSecOps Certification programs at DevOpsSchool. Gain the expertise needed to excel in your career with hands-on training and globally recognized certifications.

0
Would love your thoughts, please comment.x
()
x