3.6. Publikation auf Zenodo#
Zenodo[1] bietet eine Integration mit GitHub an, über die eine Publikation eines bestimmten Zustandes (commit) eine GitHub-Repositoriums möglich ist.
Fig. 3.3 Zugriff auf die GitHub-Integration
ist im Profil-Menü oben rechts hinterlegt.#
Für die Integration muss eine Person mit genügend Rechten im GitHub-Repositorium eine Verbindung zwischen ihrem Zenodo-Account und ihrem GitHub-Account herstellen. Öffnen Sie dazu das Menü rechts oben über den Pfeil neben Ihrem Account-Namen und wählen Sie dort GitHub aus (siehe Fig. 3.3). Folgen Sie den Anweisungen zum Verknüpfen der Accounts.
Sind die Accounts verknüpft, so sehen Sie eine Anleitung, wie ein Repositorium nach Zenodo importiert werden kann. Auf die Schritte wird hier nochmals eingegangen:
Vorbereitung des Repositoriums
Aktivierung der Integration für ein bestimmtes Repositorium
Erstellung eines Releases in GitHub
Überprüfung der Metadaten in Zenodo
3.6.1. Vorbereitung des Repositoriums#
Zenodo hat verschiedene Möglichkeiten, Metadaten aus dem Repositorium zu extrahieren und für den Eintrag auf Zenodo zu nutzen. In QUADRIGA nutzen wir die Datei CITATION.cff[2], welche es erlaubt die Metadaten im Repositorium zu definieren. Diese Datei wird auch von GitHub und anderen Werkzeugen genutzt, um Zitationsempfehlungen anzubieten.
CITATION.cff dieses Buches
1# yaml-language-server: $schema=https://citation-file-format.github.io/1.2.0/schema.json
2cff-version: 1.2.0
3title: 'QUADRIGA OERs: erstellen und gestalten mit Jupyter Book. QUADRIGA Open Educational
4 Resources: Template'
5abstract: Dieses Buch ist einerseits ein Template für die Erstellung von OERs nach
6 den Empfehlungen von QUADRIGA (https://quadriga-dk.de) und andererseits eine OER
7 für die Entwicklung von OERs entsprechend der QUADRIGA Empfehlungen.
8type: software
9message: Please cite this software using the metadata from `preferred-citation` in
10 `CITATION.cff`.
11authors: &id001
12- given-names: Hannes
13 family-names: Schnaitter
14 orcid: https://orcid.org/0000-0002-1602-6032
15 affiliation: Humboldt-Universität zu Berlin, Institut für Bibliotheks- und Informationswissenschaft
16- given-names: Evgenia
17 family-names: Samoilova
18 orcid: https://orcid.org/0000-0003-3858-901X
19 affiliation: Universität Potsdam
20- given-names: Lamia
21 family-names: Islam
22 affiliation: Universität Potsdam
23identifiers:
24- type: doi
25 value: 10.5281/zenodo.14970672
26 description: Zenodo
27repository-code: https://github.com/quadriga-dk/Book_Template
28url: https://quadriga-dk.github.io/Book_Template/
29keywords:
30- open educational resource
31license: CC-BY-SA-4.0
32references:
33- title: Jupyter Book
34 type: software
35 authors:
36 - name: The Jupyter Book Community
37 website: https://github.com/jupyter-book/jupyter-book/graphs/contributors
38preferred-citation:
39 year: 2024
40 authors: *id001
41 title: 'QUADRIGA OERs: erstellen und gestalten mit Jupyter Book. QUADRIGA Open Educational
42 Resources: Template'
43 type: book
44 doi: 10.5281/zenodo.14970672
45 url: https://quadriga-dk.github.io/Book_Template/
46 repository-code: https://github.com/quadriga-dk/Book_Template
47 license: CC-BY-SA-4.0
48 languages:
49 - deu
50 copyright: CC-BY-SA-4.0
51 keywords:
52 - Open Educational Resource
3.6.2. Aktivierung der Integration für ein bestimmtes Repositorium#
Fig. 3.4 Deaktiverter und aktivierter Schalter für
den Import neuer Releases in Zenodo.#
Für jedes Repositorium, für das Sie genügend Rechte haben, können Sie entscheiden, ob Sie neue Releases nach Zenodo importieren wollen (siehe Fig. 3.4 unten) oder nicht (siehe Fig. 3.4 oben).
Nutzen Sie diese Funktion, wenn Sie bspw. temporär neue Releases nicht in Zenodo übernehmen wollen.
3.6.3. Erstellung eines Releases in GitHub#
Fig. 3.5 Anzeige des aktuellsten Releases
auf der Hauptseite eines
Repositoriums.#
Releases in GitHub werden über einen tag spezifiziert. Diesen Tag können Sie entweder per git tag[3] festlegen, oder Sie legen beim Erstellen des Releases einen Tag an.
Klicken Sie entweder auf der Hauptseite des Repositoriums rechts auf Releases (siehe Fig. 3.5) oder oben neben der Auswahl der Branches auf Tags. Stellen Sie auf der nächsten Seite sicher, dass Releases ausgewählt ist.
Auf der Releases-Seite werden ggf. existierende Releases angezeigt, welche Sie auch durchsuchen können. Über die Schaltfläche Draft a new release können Sie einen neuen Release erstellen (siehe Fig. 3.6).
Fig. 3.6 Menüleiste der Releases-Seite mit der Schaltfläche zur Erstellung eines neuen Releases#
Beachten Sie bei der Erstellung eines neuen Releases die Hinweise in Fig. 3.7. Unter “Choose a tag” kann ein bestehender Tag ausgewählt oder eine neuer erstellt werden. Tags, die eine Version repräsentieren, sollten einem Standard folgen. Wir empfehlen für QUADRIGA den Standard Semantic Versioning 2.0.0[4].
Dann können Sie Veröffentlichungsinformationen (release notes) generieren lassen. Diese müssen ggf. angepasst werden. Der Titel des Releases ist oft eine Wiederholung des Tags, sie können jedoch auch einen sprechenden Namen vergeben. Zu den release notes gehört auch eine Beschreibung der Veränderungen zur letzten veröffentlichten Version.
Ein Release kann als neuester Release markiert werden oder als eine Vorveröffentlichung. Sie können Zwischenstände der Release-Informationen als Entwurf speichern oder den Release veröffentlichen. Veröffentlichen Sie einen Release wird dieser von Zenodo importiert, solange die Importfunktion für das Repositorium aktiviert ist (s.o.). Der Import kann einige Zeit in Anspruch nehmen.
Fig. 3.7 Seite zur Erstellung eines neuen Releases.#
3.6.4. Überprüfung der Metadaten in Zenodo#
Nach einem Release sollten die von Zenodo importierten Informationen überprüft werden. Ggf. müssen Sie in Zenodo und/oder in der Datei CITATION.cff angepasst werden. Änderungen in CITATION.cff werden mit dem nächsten Release-Import übernommen.
Zenodo stellt auch eine sogenannte Badge zur Verfügung. In den Einstellungen der GitHub-Integration wird diese neben dem Repositorium angezeigt. Klicken Sie auf diese, so öffnet sich eine Ansicht, aus der Sie bspw. Markdown-Code kopieren und Ihre README.md einfügen können.