GitHub konfigurieren

GitHub ist ein webbasierter Hosting-Service für Git-Repositorys. Sie können sowohl über lokale als auch über ferne Kopien Ihrer Repositorys verfügen, was die Zusammenarbeit sehr einfach gestaltet.

GitHub Enterprise ist ein lokaler webbasierter Hosting-Service für Git-Repositorys.

GitHub Issues ist ein Überwachungstool, das Ihre Arbeit und Ihre Pläne an einem einzigen zentralen Ort aufbewahrt. Es ist in Ihr Entwicklungsrepository integriert, damit Sie sich auf die wichtigen Aufgaben konzentrieren können.

Sie können GitHub als Toolintegration in Ihrer Toolchain konfigurieren, sodass Sie Quellcode in einem neuen oder vorhandenen Repository unter GitHub.com oder in der GitHub Enterprise-Instanz Ihres Unternehmens verwalten können. Nehmen Sie über Wikis, Problemverfolgung und Pull-Anforderungen am Social Coding teil.

Wenn Sie diese Toolintegration konfigurieren, während Sie die Toolchain erstellen, führen Sie diese Schritte aus:

Wenn Sie Ihren Quellcode in einem GitHub-Repository speichern, klicken Sie im Abschnitt mit den konfigurierbaren Integrationen auf GitHub. Wenn Sie diese Toolintegration unter IBM Cloud Public konfigurieren, dann müssen Sie IBM Cloud für den Zugriff auf GitHub berechtigen, indem Sie OAuth oder Personal Access Token auswählen.
- Wenn Sie OAuth auswählen, klicken Sie auf Berechtigen, um die GitHub aufzurufen. Wenn keine aktive GitHub-Sitzung existiert, werden Sie aufgefordert, sich anzumelden. Klicken Sie auf Authorize Application ,um den Zugriff IBM Cloud auf Ihr GitHub-Konto zuzulassen. Falls eine aktive GitHub-Sitzung existiert, Sie Ihr Kennwort aber bereits vor einiger Zeit eingegeben haben, werden Sie möglicherweise aufgefordert, Ihr GitHub-Kennwort durch erneute Eingabe zu bestätigen.
- Wenn Sie das persönliche Zugriffstoken auswählen, müssen Sie das persönliche Zugriffstoken eingeben, das für die Autorisierung mit GitHub zum Klonen von Repositorys und zum Ausführen anderer Aktionen in Ihrem Namen verwendet werden soll. Wenn Sie kein persönliches Zugriffstoken haben, können Sie anhand der Dokumentation auf der GitHub-Website ein solches erstellen. Stellen Sie sicher, dass Ihr persönliches Zugriffstoken die Berechtigungen repo, delete_repo, read:user und workflow hat.
Wenn Sie ein Repo auf Ihrem eigenen GitHub Enterprise Server verwenden, klicken Sie im Abschnitt Konfigurierbare Integrationen auf Benutzerdefinierter Server.

a. Geben Sie einen Titel für Ihren angepassten GitHub-Server ein, geben Sie die Stamm-URL für den Server an und geben Sie Ihr persönliches Zugriffstoken ein.

b. Wenn Sie kein persönliches Zugriffstoken haben, können Sie anhand der Dokumentation auf der GitHub-Website ein solches erstellen.

c. Wenn Ihr GitHub-Server Air-Gapped ist oder nicht über das öffentliche Internet erreichbar ist, können Sie einen Delivery Pipeline Private Worker anschließen und integrieren, der auf Ihrer eigenen Kubernetes-Infrastruktur läuft, um auf interne oder firmeninterne Ressourcen zuzugreifen. Weitere Informationen zu Delivery Pipeline Private Workers finden Sie unter Arbeiten mit Delivery Pipeline Private Workers.
Überprüfen Sie die Standardspeicherorte für die GitHub-Zielrepositorys. Diese Repositorys werden aus den Beispielrepositorys geklont. Ändern Sie gegebenenfalls die Namen der Zielrepositorys.

Wenn Sie diese Toolintegration zu einer bereits vorhandenen Toolchain hinzufügen, führen Sie diese Schritte aus:

Klicken Sie in der Konsole IBM Cloud auf das im Menü > Plattformautomatisierung > Toolchains. Klicken Sie auf der Seite 'Toolchains' auf die Toolchain, um die zugehörige Übersichtsseite zu öffnen. Alternativ können Sie auf der Übersichtsseite Ihrer App auf der Karte für Continuous Delivery auf Toolchain anzeigen klicken. Klicken Sie anschließend auf Übersicht.
Klicken Sie auf Tool hinzufügen.
Klicken Sie im Abschnitt mit den Toolintegrationen auf GitHub.
Klicken Sie auf den GitHub-Server, den Sie verwenden wollen.
Falls Sie über ein GitHub- oder GitHub Enterprise-Repository verfügen und dieses verwenden möchten, klicken Sie beim Repository-Typ auf Vorhanden und geben Sie die URL ein.
Falls Sie ein neues GitHub- oder GitHub Enterprise-Repository verwenden möchten, geben Sie einen Namen für das Repository ein, geben Sie die URL für das Repository ein, das Sie klonen oder verzweigen, und wählen Sie den Repository-Typ aus:

a. Klicken Sie auf Neu, um ein leeres Repository zu erstellen.

b. Klicken Sie auf Klonen, um eine Kopie eines GitHub- oder GitHub Enterprise-Repositorys zu erstellen.

c. Klicken Sie auf Verzweigen, um ein GitHub- oder GitHub Enterprise-Repository zu verzweigen, sodass Sie Änderungen per Pull-Anforderungen beitragen können.
Wenn Sie ein GitHub.com-Benutzer mit Upgrade-Konto sind oder wenn Sie einen GitHub Enterprise-Server ausgewählt haben und ein neues privates Repository auf dem Server erstellen wollen, wählen Sie das Kontrollkästchen Repository als privat definieren aus.
Wenn Sie GitHub Issues für die Verfolgung von Problemen verwenden möchten, wählen Sie das Kontrollkästchen GitHub Issues aktivieren aus.
Wenn Sie die Bereitstellung von Codeänderungen bei Commits durch Erstellen von Tags und Kommentaren und bei Problemen, die über die Commits referenziert werden, mit Bezeichnungen und Kommentaren verfolgen wollen, wählen Sie das Kontrollkästchen Bereitstellung von Codeänderungen verfolgen aus. Weitere Informationen finden Sie unter Verfolgen, wo Ihr Code mit Toolchains bereitgestellt wird.
Klicken Sie auf Integration erstellen.
Klicken Sie auf der Übersichtsseite Ihrer Toolchain auf der Karte Repositorys auf das GitHub-oder GitHub Enterprise-Repository, mit dem Sie arbeiten möchten. Abhängig von dem von Ihnen ausgewählten Repository wird entweder die GitHub-Website oder das GitHub Enterprise-Repository Ihres Unternehmens geöffnet, wo die Inhalte des Repositorys angezeigt werden.
Falls Sie GitHub Issues aktiviert haben, klicken Sie auf GitHub Issues, um GitHub Issues zu öffnen. Sie können diese Instanz von GitHub Issues für Ihre gesamte Toolchain verwenden, selbst wenn die Toolchain mehr als nur ein GitHub- GitHub Enterprise-Repository enthält.

Falls Sie nicht über Administratorberechtigung für das Repository verfügen, zu dem Sie einen Link herstellen, ist Ihre Integration eingeschränkt, da Sie keine Web-Hooks verwenden können. Web-Hooks sind erforderlich, um eine Pipeline automatisch auszuführen, wenn ein Commit per Push-Operation an das Repository übertragen wird. Ohne Web-Hook müssen Sie Ihre Pipelines manuell starten.

Konfigurieren von GitHub mithilfe der API

Die GitHub-Toolintegration unterstützt die folgenden Konfigurationsparameter, die Sie mit der Toolchain-HTTP-API und den SDKs verwenden können, wenn Sie Toolintegrationen erstellen, lesenund aktualisieren.

Sie müssen die Eigenschaft tool_type_id im Anforderungshauptteil mit dem Wert githubconsolidated angeben.

Parameter für die Integration desGitHub
Parameter	Verwendung	Typ	Terraform-Argument	Beschreibung
API-Root-URL	Optional, aktualisierbar	Zeichenfolge	API-Root-URL	Die URL des API-Stammverzeichnisses für den GitHub-Server.
API-Token	Optional, aktualisierbar	Kennwort	API-Token	Das persönliche Zugriffstoken (PAT). Dieser Parameter ist nur erforderlich, wenn `auth_type` auf `pat` gesetzt ist. Andernfalls wird er ignoriert.
auth_type	Optional, aktualisierbar	Zeichenfolge	auth_type	Legen Sie die Authentifizierungsmethode für den Zugriff auf den Git-Provider fest.
Automatische Initialisierung	optional, unveränderlich, ' `Default: false`	Boolesch	Automatische Initialisierung	Setzen Sie diesen Wert auf `true`, um dieses Repository mit einer Readme-Datei zu initialisieren. Dieser Parameter wird nur verwendet, wenn Sie ein Repository erstellen.
Blinde Verbindung	optional, aktualisierbar, ' `Default: false`	Boolesch	Blinde Verbindung	Wenn Sie diesen Wert auf "true" setzen, ist der Server im öffentlichen Internet nicht adressierbar. IBM Cloud kann die von Ihnen angegebenen Verbindungsdetails nicht validieren. Bestimmte Funktionen, die API-Zugriff auf den Git-Server erfordern, werden inaktiviert. Delivery Pipeline funktioniert nur mit einem privaten Worker, der Netzzugriff auf den Git-Server hat.
Standardverzweigung	Optional, aktualisierbar	Zeichenfolge	Standardverzweigung	Die Standardverzweigung des Git-Repositorys
enable_traceability	optional, aktualisierbar, ' `Default: false`	Boolesch	enable_traceability	Setzen Sie diesen Wert auf ' `true`, um den Einsatz von Codeänderungen zu verfolgen, indem Sie Tags, Labels und Kommentare zu Commits, Pull Requests und referenzierten Issues erstellen.
Git-ID	Optional, unveränderlich	Zeichenfolge	Git-ID	Setzen Sie diesen Wert für github.comauf `github` oder auf die GUID eines angepassten GitHub Enterprise-Servers.
has_issues	optional, aktualisierbar, ' `Default: true`	Boolesch	toolchain_issues_aktiviert	Setzen Sie diesen Wert auf `true`, um Probleme im GitHub-Repository zu aktivieren und eine Problemtoolkarte zur Toolchain hinzuzufügen. Setzen Sie den Wert auf `false`, um die Toolintegrationskarte aus der Toolchain zu entfernen. Diese Einstellung wirkt sich nicht darauf aus, ob Probleme im GitHub-Repository selbst aktiviert sind.
Integrationseigner	Optional, aktualisierbar	Zeichenfolge	Integrationseigner	Wählen Sie den Benutzer aus, für den die Git-Operationen ausgeführt werden sollen.
owner_id	Optional, unveränderlich	Zeichenfolge	owner_id	Der GitHub-Benutzer oder die Organisation, die Eigner des Repositorys ist. Dieser Parameter ist erforderlich, wenn Sie ein Repository erstellen oder ein Repository klonen oder verzweigen. Dieser Wert wird berechnet, wenn Sie einen Link zu einem vorhandenen Repository erstellen.
Privates Repository	optional, unveränderlich, ' `Default: false`	Boolesch	Privates Repository	Setzen Sie diesen Wert auf `true`, damit das Repository privat wird, wenn Sie ein Repository erstellen oder klonen oder ein Repository verzweigen. Dieser Parameter wird nicht verwendet, wenn Sie einen Link zu einem vorhandenen Repository erstellen.
ID des Repository	Optional, unveränderlich	Zeichenfolge	ID des Repository	Die ID des GitHub-Repositorys.
repo_name	Optional, unveränderlich	Zeichenfolge	repo_name	Der Name des zu erstellenden GitHub-Repositorys. Dieser Parameter ist erforderlich, wenn Sie ein Repository erstellen oder ein Repository klonen oder verzweigen. Dieser Wert wird berechnet, wenn Sie einen Link zu einem vorhandenen Repository erstellen.
repo_url	Optional, unveränderlich	Zeichenfolge	repo_url	Die URL des GitHub-Repositorys für diese Toolintegration. Dieser Parameter ist erforderlich, wenn Sie einen Link zu einem vorhandenen Repository erstellen. Dieser Wert wird berechnet, wenn Sie ein Repository erstellen oder ein Repository klonen oder verzweigen.
Root-URL	Optional, aktualisierbar	Zeichenfolge	Root-URL	Die Stamm-URL des Servers. Beispiel: https://github.example.com
Quellenrepo_url	Optional, unveränderlich	Zeichenfolge	Quellenrepo_url	Die URL des Repositorys, das Sie verzweigen oder klonen. Dieser Parameter ist erforderlich, wenn Sie ein Repository aufspalten oder klonen. Sie wird nicht verwendet, wenn Sie ein Repository oder einen Link zu einem vorhandenen Repository erstellen.
title	Optional, aktualisierbar	Zeichenfolge	title	Der Titel des Servers Beispiel: My GitHub Enterprise Server
Token-URL	Optional, aktualisierbar	Zeichenfolge	Token-URL	Die Token-URL, die für die Autorisierung mit dem GitHub-Server verwendet wird
Typ	Erforderlich, nicht veränderbar	Zeichenfolge	Typ	Die auszuführende Operation zum Initialisieren der neuen Toolintegration. Verwenden Sie `new`, um ein Git-Repository zu erstellen, `clone` um ein vorhandenes Repository in ein neues Git-Repository zu klonen, `fork` um ein vorhandenes Git-Repository zu verzweigen oder `link` um ein vorhandenes Git-Repository zu verlinken.