Logo

Artefakte in der .gitlab-ci.yml speichern

Artefakte

6.2 Artefakte speichern

Schritt 1: Artefakte in der .gitlab-ci.yml definieren

Um Artefakte in GitLab CI/CD zu speichern, müssen Sie sie in der Datei .gitlab-ci.yml definieren. Dies geschieht innerhalb der Job-Konfiguration durch die Angabe des Schlüsselworts artifacts.

Erläuterung der Artefaktkonfiguration

  • Stages: Sie können verschiedene Stages der CI/CD-Pipeline definieren, beispielsweise Build, Test und Bereitstellung.
  • Jobs: Jede Stage kann einen oder mehrere Jobs enthalten, die bestimmte Befehle ausführen. Ein Build-Job kann beispielsweise die benötigten Dateien erzeugen, während ein Test-Job Tests ausführt und Berichte erstellt.
  • Artefakte: Innerhalb jedes Jobs geben Sie mit dem Schlüsselwort artifacts an, welche Artefakte gespeichert werden sollen. Dadurch stehen diese Dateien in nachfolgenden Jobs oder Stages Ihrer Pipeline zur Verfügung.
  • Abhängigkeiten: Über dependencies legen Sie fest, welche Artefakte ein Job von vorherigen, erfolgreich abgeschlossenen Jobs erhält. Die Reihenfolge der Ausführung wird dagegen durch die Stages bestimmt.

Praktische Übung 6.2: Artefakte in unserer CI/CD-Pipeline verwenden

Ergänzen Sie die CI/CD-Pipeline des Projekts zur Analyse von Forschungspublikationen um Artefakte. Die Testergebnisse werden dabei in einer Artefaktdatei gespeichert, um später darauf zurückgreifen zu können.

stages:
  - build
  - test
  - deploy

build_job:
  stage: build
  script:
    - echo "Anwendung wird gebaut..."
    - pip install -r requirements.txt
    - python setup.py build --build-base build
    - echo "Build abgeschlossen"
  artifacts:
    paths:
      - build/

test_job:
  stage: test
  script:
    - echo "Tests werden ausgeführt"
    - mkdir -p test-results
    - pytest tests/ > test-results/report.txt
  artifacts:
    paths:
      - test-results/report.txt

deploy_job:
  stage: deploy
  script:
    - echo "Projekt wird bereitgestellt"

5. Pipeline ausführen:

Committen und übertragen Sie die Datei .gitlab-ci.yml, um die Pipeline in GitLab auszulösen:

git add .gitlab-ci.yml
git commit -m "Add CI configuration with artifacts"
git push origin main

Passen Sie den Branch-Namen bei Bedarf an.

6. Gespeicherte Artefakte prüfen:

  • Öffnen Sie Ihr GitLab-Projekt, wechseln Sie in den Bereich Pipelines und wählen Sie den letzten Pipeline-Durchlauf aus. Prüfen Sie anhand der Ausgabe Ihrer Jobs, ob die Artefakte korrekt gespeichert wurden.