Nachdem ich in meinem bislang jüngsten Github-Projekt meine Liebe zu Badges entdeckt habe, wollte ich versuchen, das in meinem lokalen Gitlab ebenfalls zu nutzen

In Github ist es - aus meiner Sicht - sehr einfach, schnell große Mengen an Badges zu erzeugen. Trotz der offenen Tickets wegen der mangelhaften Dokumentation des Features hat sich in der Beziehung noch nicht sehr viel getan. Daher musste ich in den sauren Apfel beißen und experimentieren. Die unten angehängten Links zu dem Thema sind nur ein kleiner Auszug aus den vielen Ressourcen, die ich auf der Suche nach einer Anleitung für Badges in Gitlab besucht habe.

Mein erster Versuch war, die in der Gitlab-Dokumentation erwähnte Möglichkeit nachzuvollziehen, ein Badge für den Pipeline-Status einzubauen. Das funktionierte tatsächlich so, wie in der Dokumentation angegeben - Bei mir sieht die URL zum Zugriff auf den Badge also so aus:

http://<gitlab-host>/%{project_path}/badges/%{default_branch}/pipeline.svg

Der nächste Schritt war es, eigene Badges zu erzeugen und sie in den Settings zu registrieren. Ich wollte zunächst mit einem statischen Badge beginnen - dynamische Inhalte sollten dann den Abschluss und die Krönung meiner Forschungen darstellen. Ich fand eine für mich ausreichende Möglichkeit der Erstellung von Badges im Projekt anybadge. Aber natürlich gibt es noch deutlich mehr Möglichkeiten - etwa die üblichen Verdächtigen shields.io.

Nachdem das geklärt war - wie erzeugt man nun im CI/CD-Prozess einen Badge, der als Project-Badge in Gitlab funktioniert? Ich habe hier mal das Beispiel abgebildet, das den in der anybadge-Dokumentation gezeigten Badge erstellt, so dass ich ihn in Gitlab als Project-Badge nutzen kann. Dazu ist folgener Job in die Pipeline aufzunehmen:

badges_before:
    stage: start
    script:
        - mkdir -p badges
        - anybadge -l pylint -v 2.22 -f badges/pylint_${CI_COMMIT_REF_NAME}.svg 2=red 4=orange 8=yellow 10=green
    artifacts:
        paths:
        - badges/*.svg

Auf diese Weise entsteht ein Badge, der dann in den Settings wie folgt eingetragen werden kann:

http://<gitlab-host>/%{project_path}/-/jobs/artifacts/%{default_branch}/raw/badges/pylint_%{default_branch}.svg?job=badges_before

Wichtig ist hier vor allem der Name des Jobs am Ende! Nun da das geklärt ist - zum bereits angekündigten Sahnehäubchen: Dem dynamischen Erzeugen von Badges. Dies geschah wieder in zwei Schritten: Schritt eins umfasste die Extraktion von Daten aus Dateien im Repository - das sah bei mir zum Beispiel wie folgt aus:

badges_before:
    stage: start
    script:
        - mkdir -p badges
        - anybadge -m "%s" -l sQLshell -v `more de/elbosso/db/prg/version.properties |grep version.program.number|cut -d '=' -f2` -f badges/sQLshell_${CI_COMMIT_REF_NAME}.svg 2=red 4=orange 8=yellow 10=green
    artifacts:
        paths:
        - badges/*.svg

So erhalte ich einen Badge mit der aktuellen Version der sQLshell, den ich dann meinen Project-Badges wie folgt hinzufügen kann:

http://<gitlab-host>/%{project_path}/-/jobs/artifacts/%{default_branch}/raw/badges/sQLshell_%{default_branch}.svg?job=badges_after

Im zweiten und letzten Schritt setzte ich dem Ganzen noch die Krone auf - jetzt wollte ich es wissen und wirklich die gleiche Funktionalität wie bei Github erreichen: Ich wollte über die API Informationen extrahieren und diese mittels Project-Badges visualisieren. Als Thema suchte ich mir dazu die Anzahl der offenen/geschlossenen Issues aus. Dieses Thema konnte ich leider nicht mehr in .gitlab-ci.yml umsetzen - da scheint entweder der YAML-Parser einen Bug zu haben oder ich den YAML-Parser noch nicht verstanden zu haben. Also erstellte ich ein Script, das letztlich den darzustellenden Wert ermittelt - im Beispiel open_issues.sh:

#!/bin/bash
curl -i --header "Private-Token: xxxx-xxxx-xxxxxxxxxx" "http://<gitlab-host>/api/v4/projects/1/issues?state=opened&scope=all" 2>/dev/null|grep "X-Total:"|cut -d ':' -f 2

Wichtig dabei ist hier der korrekte Wert für die Project-ID (bei mir: 1) und der eigene für das Access-Token. Dieses Skript kann ich dann wie oben gesehen in .gitlab-ci.yml verwenden um den Badge zu erzeugen:

badges_before:
    stage: start
    script:
        - mkdir -p badges
        - anybadge -m "%d" -l "open issues" -v `/bin/bash ci/open_issues.sh` -f badges/open_issues_${CI_COMMIT_REF_NAME}.svg 2=red 4=orange 8=yellow 10=green
    artifacts:
        paths:
        - badges/*.svg

Damit erhalte ich einen Badge, den ich dann wiederum als Project-Badge deklarieren kann:

http://<gitlab-host>/%{project_path}/-/jobs/artifacts/%{default_branch}/raw/badges/open_issues_%{default_branch}.svg?job=badges_before

Links

Artikel, die hierher verlinken