pipeline-mermaid 0.5

Useful tool to show Gitlab pipeline as mermaid

Pipeline as mermaid

The useful tool to show Gitlab pipeline as mermaid

required environments

• GITLAB_API_TOKEN - gitlab api token

Using

Show current pipeline in merge request notes. Example merge request

in .gitlab-ci.yml

notify merge request:
  image: registry.gitlab.com/nov1kov/pipeline_to_mermaid:0.5
  stage: deploy
  only:
    - merge_requests
  script:
    - pipeline-mermaid show_current_pipeline

as python package

install

pip install pipeline-mermaid

show current pipeline in current merge request as gantt diagram

pipeline-mermaid show_pipeline

show specific pipeline in specific merge request as gantt diagram

pipeline-mermaid show_pipeline 249125838 gantt 3 

as python library

from pipeline_mermaid.gitlab_helper import GitlabHelper

gl = GitlabHelper()
gl.show_pipeline(249125838, "gantt", 3)

Gitlab pipeline as mermaid

graph LR

classDef failed fill:white,stroke:#db3b21,color:black;
classDef success fill:white,stroke:#1aaa55,color:black;
classDef warning fill:white,stroke:#fc9403,color:black;
classDef skipped fill:white,stroke:#999,color:black;

730991283(android)
730991285(s3)
730991286(firebase)
730991287(slack)

730991283 --> 730991285
730991283 --> 730991286
730991285 --> 730991287
730991286 --> 730991287

class 730991283 success
class 730991285 warning
class 730991286 success
class 730991287 failed

gantt

dateFormat  YYYY-MM-DDTHH:mm:ss.SSSZ
axisFormat  %H:%M:%S

section test
unit tests : 730991283, 2020-09-12T12:26:05.370Z, 2020-09-12T12:26:41.665Z

section build
build : 730991284, 2020-09-12T12:26:42.182Z, 2020-09-12T12:27:38.126Z

section deploy
s3 : 730991285, 2020-09-12T12:27:43.757Z, 2020-09-12T12:28:35.406Z
firebase : 730991286, 2020-09-12T12:27:43.757Z, 2020-09-12T12:28:44.406Z

journey
section build
  android: -1: running
  ios: -1: running
section deploy
  slack-android: -1: created
  slack-ios: -1: created

todo:

gitlab

• try depend on CI_JOB_TOKEN

mermaid

• interactions https://mermaid-js.github.io/mermaid/diagrams-and-syntax-and-examples/gantt.html#interaction
• state

documentaion

• https://pdoc3.github.io/pdoc/
• https://pydoc-markdown.readthedocs.io/en/latest/docs/api-documentation/processors/

ci tools

• https://gitlab.version.fz-juelich.de/vis/jusense-cicd/-/wikis/discussion-on-howto-include-badges-in-gitlab-...
• https://github.com/jongracecox/anybadge
• https://docs.gitlab.com/ee/api/wikis.html
• gitlab release versions
• pylint (show errors in MR)

0.5

• support downstream pipelines

0.4

• global command "pipeline-mermaid"
• custom message ability

0.3

• support repeated jobs

0.2

• support journey diagram
• methods for using by one line

0.1

• Show gitlab pipeline as gantt diagram
• Show gitlab pipeline as graph LR