Logo

Versioning Strategies

DOIs für GitLab-Repositories zuweisen

< >

DOIs für GitLab-Repositories zuweisen

GitLab unterstützt die Erstellung von DOIs (Digital Object Identifiers) nicht direkt. Sie können jedoch Plattformen wie Zenodo nutzen, um DOIs zu generieren und diese mit Ihren GitLab-Repositories zu verknüpfen. Der Prozess umfasst das Archivieren einer spezifischen Version Ihres Codes und die Registrierung bei Zenodo, um einen dauerhaften Identifier zu erhalten.

Schritt 1: Erstellen Sie ein Release in GitLab und laden Sie ein Archiv (z. B. ZIP-Datei) des Codes hoch.

In der Projektansicht finden Sie den Bereich “Releases”, wenn Sie den Abschnitt “Deploy” ausklappen.

  • Navigieren Sie zu Ihrem Repository auf GitLab.
  • Gehen Sie zu “Releases” > “Neues Release”, vergeben Sie ein Versions-Tag (z. B. v1.0) und fügen Sie das ZIP-Archiv Ihres Projekts hinzu.

GitLab-Release-Seite mit einem bereits erstellten Release.

Schritt 2: Nutzen Sie die Zenodo-API oder den manuellen Prozess, um das Archiv zu registrieren und einen DOI zu erhalten.

Zenodo-Anmeldeseite mit verschiedenen Sign-in-Optionen.

  • Melden Sie sich mit Ihrer bevorzugten Methode an

Zenodo-Dashboard mit hervorgehobener Schaltfläche “New Upload”.

  • Erstellen Sie einen neuen Upload (oben rechts)

Zenodo-Formular für neuen Upload mit Feldern für Metadaten und Dateien.

  • Laden Sie die ZIP-Datei über die Zenodo-Weboberfläche oder die Zenodo-API hoch.
  • Wählen Sie aus, ob für das Projekt bereits ein DOI existiert; in unserem Fall: Nein.
  • Hinterlegen Sie Metadaten (z. B. Titel, Beschreibung, Autor*in) und generieren Sie einen DOI für das Release.

Zenodo-Upload-Formular mit Feld zum Eintragen der Repository-URL.

  • Fügen Sie die Repository-URL zu git.nrw hinzu

Schritt 3: Verknüpfen Sie den DOI mit Ihrem Repository über die Zenodo-/GitLab-Integration oder integrieren Sie ihn in die Dokumentation.

  • Kopieren Sie den von Zenodo bereitgestellten DOI (z. B. 10.5281/zenodo.1234567).
  • Fügen Sie den DOI-Badge oder Link in die README.md oder das Wiki Ihres GitLab-Projekts ein:
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1234567.svg)](https://doi.org/10.5281/zenodo.1234567)

git.nrw-Projekteinstellungen in GitLab.

  • Gehen Sie zu den Projekteinstellungen

GitLab-Badge-Bereich mit Option zum Hinzufuegen eines neuen Badges.

  • Klicken Sie auf “New badge”

GitLab-Formular zum Erstellen eines neuen Projekt-Badges.

  • Fuellen Sie das Link-Feld mit Ihrem DOI aus
  • Tragen Sie den DOI in https://zenodo.org/badge/DOI/<IHRE-DOI-HIER>.svg ein

Projektuebersicht mit eingeblendetem DOI-Badge auf git.nrw.

Alternativ: Verwendung eines Skripts zur automatischen DOI-Erstellung

Falls Sie den Prozess der DOI-Erstellung automatisieren möchten, können Sie das unoffizielles Skript gitlab2zenodo verwenden. Dieses Skript hilft Ihnen dabei, Ihr GitLab-Repository mit Zenodo zu verknüpfen und DOIs automatisiert zu generieren.

Externe Anleitung:

Sacha Beniamine: gitlab2zenodo

Hinweis:

Dieses Skript ist unoffizielles von GitLab oder Zenodo unterstützt.

Bitte überprüfen Sie das Skript und die dazugehörige Dokumentation auf Aktualität und Sicherheitshinweise, bevor Sie es verwenden.

Alternativ: Nutzung der GitHub-Zenodo-Integration über GitHub-Mirror

Falls Sie lieber mit offiziellen Tools arbeiten möchten, können Sie Ihr GitLab-Repository auf GitHub spiegeln und dort die offizielle Zenodo-Integration nutzen. Auf diese Weise können Sie DOIs für Ihr GitLab-Repository erstellen, indem Sie die DOI-Generierung über GitHub durchführen.

Externe Anleitung:

Überblick der TU Hamburg Detaillierte Anleitung der TU Hamburg

Dieser Leitfaden basiert auf folgenden Quellen: