Skip to content

Latest commit

 

History

History
51 lines (36 loc) · 2.03 KB

gitlab.md

File metadata and controls

51 lines (36 loc) · 2.03 KB
Raw

GitLab

Pattern: /gitlab/projects/{repo}/files/{commit}/{path}

Example: https://demo.puml.net/gitlab/projects/32006361/files/main/gitlab.md

@startuml
puml->GitLab: Hello
caption Generated at %date("yyyy-MM-dd HH:mm:ss z")
@enduml

demo

Pattern: /gitlab/projects/{repo}/files/{commit}/{path}?pumlIndex={n}

Example: https://demo.puml.net/gitlab/projects/32006361/files/main/gitlab.md?pumlIndex=1

@startuml

participant browser as b
participant puml as p
participant GitLab as gl

b->p: GET /gitlab/projects/32006361/files/main/gitlab.md?pumlIndex=1
p->gl: GET https://gitlab.com/api/v4
gl->p: Plain Text
p->b: PNG

caption Generated at %date("yyyy-MM-dd HH:mm:ss z")

@enduml

demo

Rendering protected sources

Protected sources can be accessed by setting up credentials in config file, for example

Example: https://demo.puml.net/gitlab/projects/32007598/files/main/gitlab.md demo

Rendering for Private GitLab Instances

Private GitLab instance, even multiple instances, are also supported, via host mapping.

Pattern: /gitlab/{key}/projects/{repo}/files/{commit}/{path}

Host mapping for {key} needs to be configured in config.yaml, for example.

Example: https://demo.puml.net/gitlab/gle/projects/32007598/files/main/gitlab.md demo

NOTE: Unfortunately I don't have a private gle instance to properly demo this, so instead I'm mapping gle to gitlab.com for this case.