Edit

CLI Nutzung

Diese Dokumentation geht davon aus, dass Du die Schritte der CLI-Installation bereits befolgt hast.

Hinweis: Um das Beispiel möglichst einfach zu halten, zeigen wir Dir unten nur all-contributors. Wenn es damit Schwierigkeiten geben sollte, dann versucht es mit yarn all-contributors 😺

Befehle

all-contributors init

Führe dies zuerst aus, wenn du mit all-contributors-cli loslegen möchtest. Dieser Befehl stellt Dir einige Fragen und richtet das Projekt für die Verwendung mit all-contributors ein. Dieser Prozess beinhaltet das Erstellen der .all-contributorsrc Konfigurationsdatei und dem Erstellen der Tabelle der Mitwirkenden in den Dateien (files) welche du spezifiziert hast. In der Regel in der README.md Datei.

all-contributors add

Benutze add um neue Mitwirkende deinem Projekt - oder bestehenden Mitwirkenden andere Wege in denen sie beigetragen haben hinzuzufügen. Sie werden zur Konfigurationsdatei hinzugefügt, und die Tabelle der Mitwirkenden wird aktualisiert, genauso als ob du den Befehl generate benutzt hättest.

# Neuen Mitwirkenden <username>, welcher eine Beitrag vom Typ <contribution> gemacht hat, hinzufügen
all-contributors add <username> <contribution>
# Beispiel:
all-contributors add jfmengels code,doc

Wobei username der GitHub oder Gitlab Benutzername and contribution eine durch ,-separierte Liste der Beitragstypen ist. Schau Dir den Emoji Key (Referenz Beitragstypen) durch. Dort ist eine Liste gültiger contribution Typen hinterlegt.

Hinweis für GitLab Benutzer: Schau Dir zusätzlichen Anforderungen für GitLab Benutzer durch

all-contributors check

Benutze check um die Mitwirkenden auf GitHub mit denen in der .all-contributorsrc Datei abzugleichen um sicherzustellen, dass alle Beiträge in der selben Form gewürdigt werden.

Aufgrund von GitHub API Einschränkungen funktioniert dieser Befehl nur für Projekte mit weniger als 500 Mitwirkenden (sofern Du keinen PRIVATE_TOKEN, wie in GitHub-Benutzer erwähnt, hinzugefügt hast).

all-contributors generate

Benutze generate um die contributors Liste aus der .all-contributorsrc Datei zu lesen und die Tabelle der Mitwirkenden entsprechend der Spezifikation im files Key zu aktualisieren.

Bitte beachte, dass der Befehl in der Lage sein muss die folgenden Tags zu finden, um die Tabelle aktualisieren zu können:

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- ALL-CONTRIBUTORS-LIST:END -->

Also note that it needs to find the following tags in order to update the badge:

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
<!-- ALL-CONTRIBUTORS-BADGE:END -->

GitHub Benutzer

In manchen Fällen ist es möglich, dass Du auf den Fehler GitHub API rate limit exceeded for xxx stösst. Dann musst Du ggf. die Umgebungsvariable PRIVATE_TOKEN setzen, um die GitHub rate limits zu umgehen.

Der PRIVATE_TOKEN ist Dein persönlicher Zugangstoken um Dich beim API von GitHub zu authentifizieren.

GitLab Benutzer

Bitte beachte, dass wenn Du eine selbst gehosteten Gitlab-Instanz verwendest, einige dieser Befehle voraussetzen, dass die Umgebungsvariable PRIVATE_TOKEN gesetzt ist.

Der PRIVATE_TOKEN ist Dein persönlicher Zugangstoken um Dich beim API von GitLab zu authentifizieren.

# set private token on Linux
export PRIVATE_TOKEN=your_private_token
# set private token on Windows
set PRIVATE_TOKEN=your_private_token

Wie geht es weiter?

← InstallationKonfiguration →