{"id":49526,"date":"2025-05-28T03:16:55","date_gmt":"2025-05-28T03:16:55","guid":{"rendered":"https:\/\/www.devopsschool.com\/blog\/?p=49526"},"modified":"2025-05-28T03:16:55","modified_gmt":"2025-05-28T03:16:55","slug":"gitlab-reference-linking-guide-such-users-commits-etc","status":"publish","type":"post","link":"https:\/\/www.devopsschool.com\/blog\/gitlab-reference-linking-guide-such-users-commits-etc\/","title":{"rendered":"GitLab Reference & Linking Guide such users, commits etc"},"content":{"rendered":"\n

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

\n\n\n\n

\ud83d\udcd8 GitLab Reference & Linking Guide (v18.x compatible)<\/strong><\/h2>\n\n\n\n

GitLab provides Markdown and keyword-based shortcuts to cross-reference<\/strong> nearly every object in the system for traceability, collaboration, and automation.<\/p>\n\n\n\n

\n\n\n\n

\u2705 1. Issues<\/strong><\/h3>\n\n\n\n

\ud83d\udd39 Where to Reference<\/h4>\n\n\n\n
    \n
  • Commit messages: Fixes #123<\/code><\/li>\n\n\n\n
  • Merge Request description: Closes #123<\/code><\/li>\n\n\n\n
  • Comments, Wiki, Readme: #123<\/code><\/li>\n<\/ul>\n\n\n\n

    \ud83d\udd39 Format<\/h4>\n\n\n
    #123              \/\/ Just refers to issue<\/span>\nFixes #123        \/\/ Closes on merge<\/span>\nSee issue #123    \/\/ Mentions without closing<\/span>\n<\/code><\/span>Code language:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
    \n\n\n\n
    \u2705 2. Merge Requests (MRs)<\/strong><\/h3>\n\n\n\n
    \ud83d\udd39 Where to Reference<\/h4>\n\n\n\n
      \n
    • Wiki: !45<\/code><\/li>\n\n\n\n
    • Issues, Comments: See !45<\/code><\/li>\n\n\n\n
    • Commit Messages (rare)<\/li>\n<\/ul>\n\n\n\n
      \ud83d\udd39 Format<\/h4>\n\n\n
      !45\nSee merge request !45\n<\/code><\/span><\/pre>\n\n\n
      \n\n\n\n
      \u2705 3. Commits<\/strong><\/h3>\n\n\n\n
      \ud83d\udd39 Where to Reference<\/h4>\n\n\n\n
        \n
      • Issues, MRs: abcd1234<\/code> or project@abcd1234<\/code><\/li>\n<\/ul>\n\n\n\n
        \ud83d\udd39 Format<\/h4>\n\n\n
        abcd1234              \/\/ Short SHA<\/span>\nproject@abcd1234      \/\/ Cross-project<\/span>\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
        \n\n\n\n
        \u2705 4. Jobs (CI\/CD)<\/strong><\/h3>\n\n\n\n
        \ud83d\udd39 Where to Reference<\/h4>\n\n\n\n
          \n
        • Pipeline tab or job logs in UI (not Markdown-accessible)<\/li>\n\n\n\n
        • Use direct links or job artifacts in comments or wiki<\/li>\n<\/ul>\n\n\n\n
          \ud83d\udd39 Format (Manual linking)<\/h4>\n\n\n
          [View Job Log](https:\/\/gitlab.com\/namespace\/project\/-\/jobs\/123456789)<\/span>\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
          \n\n\n\n
          \u2705 5. Milestones<\/strong><\/h3>\n\n\n\n
          \ud83d\udd39 Where to Reference<\/h4>\n\n\n\n
            \n
          • Issues, MRs, Wiki: %milestone_name<\/code><\/li>\n<\/ul>\n\n\n\n
            \ud83d\udd39 Format<\/h4>\n\n\n
            %v1<\/span>.0<\/span>\nTargeted<\/span> for<\/span> %Q2-Release<\/span>\n<\/code><\/span>Code language:<\/span> CSS<\/span> (<\/span>css<\/span>)<\/span><\/small><\/pre>\n\n\n
            \n\n\n\n
            \u2705 6. Requirements (GitLab Ultimate)<\/strong><\/h3>\n\n\n\n
            \ud83d\udd39 Where to Reference<\/h4>\n\n\n\n
              \n
            • Issues, MRs, Descriptions, Wiki: REQ-1<\/code>, requirements#123<\/code><\/li>\n<\/ul>\n\n\n\n
              \ud83d\udd39 Format<\/h4>\n\n\n
              Relates<\/span> to<\/span> requirements<\/span>#12<\/span>\n<\/code><\/span>Code language:<\/span> CSS<\/span> (<\/span>css<\/span>)<\/span><\/small><\/pre>\n\n\n
              \n
              Enabled under Requirements Management<\/strong> in project settings.<\/p>\n<\/blockquote>\n\n\n\n
              \n\n\n\n
              \u2705 7. Users<\/strong><\/h3>\n\n\n\n
              \ud83d\udd39 Where to Mention<\/h4>\n\n\n\n
                \n
              • Any Markdown-supported field: descriptions, comments, commit messages<\/li>\n<\/ul>\n\n\n\n
                \ud83d\udd39 Format<\/h4>\n\n\n
                @username<\/span>\nAssigned to @john_doe\n<\/code><\/span>Code language:<\/span> CSS<\/span> (<\/span>css<\/span>)<\/span><\/small><\/pre>\n\n\n
                \n\n\n\n
                \u2705 8. Labels<\/strong><\/h3>\n\n\n\n
                \ud83d\udd39 Where to Use<\/h4>\n\n\n\n
                  \n
                • Issue or MR references: ~\"bug\"<\/code> or ~bug<\/code><\/li>\n<\/ul>\n\n\n\n
                  \ud83d\udd39 Format<\/h4>\n\n\n
                  ~\"feature\"<\/span>\n~backend\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
                  \n\n\n\n
                  \u2705 9. Environments (CI\/CD)<\/strong><\/h3>\n\n\n\n
                  \ud83d\udd39 Where to Reference<\/h4>\n\n\n\n
                    \n
                  • Pipeline views, API, job logs<\/li>\n<\/ul>\n\n\n\n
                    \ud83d\udd39 Format<\/h4>\n\n\n
                    [View Staging](https:\/\/gitlab.com\/namespace\/project\/-\/environments\/123)<\/span>\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
                    \n\n\n\n
                    \u2705 10. Epics (GitLab Premium+)<\/strong><\/h3>\n\n\n\n
                    \ud83d\udd39 Where to Reference<\/h4>\n\n\n\n
                      \n
                    • Issues, MRs, descriptions, comments: &123<\/code><\/li>\n<\/ul>\n\n\n\n
                      \ud83d\udd39 Format<\/h4>\n\n\n
                      Part of epic &45\n<\/code><\/span><\/pre>\n\n\n
                      \n\n\n\n
                      \u2705 11. Snippets<\/strong><\/h3>\n\n\n\n
                      \ud83d\udd39 Where to Reference<\/h4>\n\n\n\n
                        \n
                      • Wiki, comments: $snippet_id<\/code><\/li>\n<\/ul>\n\n\n\n
                        \ud83d\udd39 Format<\/h4>\n\n\n
                        $42\n<\/code><\/span><\/pre>\n\n\n
                        \n\n\n\n
                        \u2705 12. Wiki Pages<\/strong><\/h3>\n\n\n\n
                        \ud83d\udd39 Where to Reference<\/h4>\n\n\n\n
                          \n
                        • Markdown everywhere<\/li>\n<\/ul>\n\n\n\n
                          \ud83d\udd39 Format<\/h4>\n\n\n
                          [Deployment Guide](..\/wikis\/deployment)\n<\/code><\/span><\/pre>\n\n\n
                          \n\n\n\n
                          \u2705 13. Projects<\/strong><\/h3>\n\n\n\n
                          \ud83d\udd39 Cross-project linking:<\/h4>\n\n\n
                          group\/project#123         \/\/ Issue<\/span>\ngroup\/project!456<\/span>         \/\/ MR<\/span>\ngroup\/project@SHA         \/\/ Commit<\/span>\n<\/code><\/span>Code language:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
                          \n\n\n\n
                          \u2705 14. Pipeline Status Badges<\/strong><\/h3>\n\n\n
                          [![pipeline status](https:\/\/gitlab.com\/group\/project\/badges\/main\/pipeline.svg)](https:\/\/gitlab.com\/group\/project\/pipelines)<\/span>\n<\/code><\/span>Code language:<\/span> JSON \/ JSON with Comments<\/span> (<\/span>json<\/span>)<\/span><\/small><\/pre>\n\n\n
                          \n\n\n\n
                          \ud83d\udccc Markdown Reference Shortcuts Summary<\/h2>\n\n\n\n
                          Reference Type<\/th>Syntax Example<\/th>Description<\/th><\/tr><\/thead>
                          Issue<\/td>#123<\/code><\/td>Links to issue<\/td><\/tr>
                          Merge Request<\/td>!45<\/code><\/td>Links to MR<\/td><\/tr>
                          Commit<\/td>abcd1234<\/code><\/td>Links to commit<\/td><\/tr>
                          Milestone<\/td>%v1.0<\/code><\/td>Links to milestone<\/td><\/tr>
                          Label<\/td>~bug<\/code><\/td>Links to label<\/td><\/tr>
                          User<\/td>@username<\/code><\/td>Mentions user<\/td><\/tr>
                          Epic<\/td>&12<\/code><\/td>Links to epic (Premium+)<\/td><\/tr>
                          Requirement<\/td>requirements#123<\/code><\/td>Links to requirement (Ultimate)<\/td><\/tr>
                          Snippet<\/td>$42<\/code><\/td>Links to code snippet<\/td><\/tr>
                          Environment Link<\/td>Direct URL<\/td>Link to job\/env logs<\/td><\/tr>
                          Cross-project<\/td>group\/project#123<\/code><\/td>Ref to other repo issue\/MR<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                          \n\n\n\n
                          \ud83e\udde0 Tips<\/h2>\n\n\n\n
                            \n
                          • GitLab autolinks most entities with typeahead autocomplete<\/strong> when typing @<\/code>, #<\/code>, !<\/code>, etc.<\/li>\n\n\n\n
                          • Use templates<\/strong> (issue\/MR\/wikis) to enforce referencing conventions.<\/li>\n\n\n\n
                          • Use custom sections in MRs<\/strong> like: ### Linked Issues Fixes #123 ### Related MRs See !45<\/code><\/li>\n<\/ul>\n\n\n\n
                            \n\n\n\n
                            <\/p>\n","protected":false},"excerpt":{"rendered":"
                            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…. <\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"","sticky":false,"template":"","format":"standard","meta":{"_joinchat":[],"footnotes":""},"categories":[2],"tags":[],"class_list":["post-49526","post","type-post","status-publish","format-standard","hentry","category-uncategorised"],"_links":{"self":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/49526","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/comments?post=49526"}],"version-history":[{"count":1,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/49526\/revisions"}],"predecessor-version":[{"id":49527,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/49526\/revisions\/49527"}],"wp:attachment":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/media?parent=49526"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/categories?post=49526"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/tags?post=49526"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}