Überprüfen und Übermitteln eines Pull Requests

Der Pull Request (PR) ist Ihre Möglichkeit, Ihr Wissen auf der Learn-Plattform zu teilen. Sie haben einen PR erstellt, aber dieser wurde noch nicht an die PR-Warteschlange des Zielrepositorys übermittelt. Wie bei vielen Open-Source-Projekten gibt es eine Reihe von Überprüfungen und Reviews, die durchgeführt werden, um Änderungen vor der Veröffentlichung zu prüfen.

Inhalt eines PR

Ein PR liefert Informationen zu den GitHub-Benutzer*innen, die den PR erstellt haben, dem Zielrepository und dem Branch, in dem der PR erstellt wurde. PRs enthalten im oberen Bereich mehrere Registerkarten:

• Registerkarte Unterhaltung: Dies ist ein Dashboard, über das Sie Kommentare von anderen Mitwirkenden anzeigen und darauf antworten können. Zudem können Sie eine Liste der Benachrichtigungen im Zusammenhang mit dem Erstellungs- und Überprüfungsprozess anzeigen und die Kommentarautomatisierung verwenden, um Aktionen auszuführen.
• Registerkarte Commits: Hier werden die Änderungen aufgezeichnet, die an diesem Branch vorgenommen wurden.
• Registerkarte "Dateien geändert": Ein Vergleich der geänderten Dateien in der PR mit ihrem vorherigen Status.

Achten Sie auf die Registerkarte „Unterhaltungen“, auf der alle Aktualisierungen oder Benachrichtigungen sowie alle Diskussionen zwischen Ihnen, den Reviewer*innen und anderen Mitwirkenden angezeigt werden. Sie können hier auch Hashtagkommentare zum Ausführen von Aktionen hinzufügen, um beispielsweise anzugeben, dass der PR freigegeben ist und zunächst überprüft und anschließend gemergt werden kann oder noch zurückgehalten werden soll, wenn Sie den Prozess anhalten müssen.

PRs weisen häufig Bezeichnungen auf, um ihren Status anzugeben (z. B. draft für Entwurfs-PRs, die noch nicht für die Überprüfung bereit sind, oder do-not-merge für neue oder noch nicht überprüfte PRs).

Überprüfung

Bevor Ihr PR mit dem Zielbranch gemergt werden kann, ist es möglicherweise erforderlich, einen oder mehrere PR-Validierungsprozesse zu durchlaufen. Nachdem Sie " Pullanforderung erstellen" ausgewählt haben, führt GitHub die für Ihr Repository konfigurierten Überprüfungen aus. Nach Abschluss des Validierungsprozesses werden die Ergebnisse im PR angezeigt.

Validierungsprozesse variieren je nach Umfang der vorgeschlagenen Änderungen und den Regeln des Zielrepositorys. Nachdem Sie Ihren PR übermittelt haben, können Sie davon ausgehen, dass mindestens eine der folgenden Validierungen erfolgt:

• Zusammenführbarkeit: Zunächst wird ein grundlegender GitHub-Zusammenführbarkeitstest durchgeführt, um zu überprüfen, ob die vorgeschlagenen Änderungen in Ihrem Branch mit dem Ziel-Branch im Konflikt stehen. Wenn der PR angibt, dass dieser Test fehlgeschlagen ist, müssen Sie den Inhalt überarbeiten, der den Mergekonflikt verursacht, bevor die Verarbeitung fortgesetzt werden kann.
• Lizenzvertrag für Beitragslizenzierung (CLA): Wenn Sie zu einem öffentlichen Repository beitragen und je nach Umfang der vorgeschlagenen Änderungen kein Microsoft-Mitarbeiter sind, werden Sie möglicherweise aufgefordert, eine kurze CLA abzuschließen, wenn Sie zum ersten Mal eine PR an dieses Repository übermitteln. Nachdem der CLA-Schritt erfolgt ist, wird Ihr PR verarbeitet.
• Bezeichnung: Bezeichnungen werden automatisch auf Ihren PR angewendet, um seinen Status anzugeben, während dieser den Validierungsworkflow durchläuft. Beispielsweise können neue PRs automatisch mit der Bezeichnung do-not-merge versehen werden, die angibt, dass der PR die Validierungs-, Review- und Freigabeschritte noch nicht abgeschlossen hat.
• Validierung und Build: Automatisierte Prüfungen verifizieren, ob Ihre Änderungen die Validierungstests bestehen. Die Validierungstests führen möglicherweise zu Warnungen oder Fehlern, sodass Sie Änderungen an einer oder mehreren Dateien in Ihrem PR vornehmen müssen, bevor dieser gemergt werden kann. Die Validierungstestergebnisse für die Überprüfung werden Ihrem PR als Kommentar hinzugefügt und möglicherweise auch per E-Mail an Sie gesendet.
• Staging: Die von Ihren Änderungen betroffenen Artikelseiten werden automatisch in einer Stagingumgebung zur Überprüfung nach erfolgreicher Überprüfung und Erstellung bereitgestellt. Vorschau-URLs werden in einem PR-Kommentar angezeigt.
• Automatische Zusammenführung: Die PR wird möglicherweise automatisch zusammengeführt, wenn sie Überprüfungstests und bestimmte Kriterien bestanden hat. In diesem Fall müssen Sie nichts mehr tun.

Prüfen und Freigeben

Sie haben es fast geschafft! Nachdem die PR-Verarbeitung abgeschlossen wurde, empfiehlt es sich, die Ergebnisse zu prüfen (z. B. PR-Kommentare und Vorschau-URLs), um festzustellen, ob weitere Änderungen erforderlich sind, bevor Sie den PR zum Mergen freigeben. Wenn ein*e PR-Reviewer*in Ihren PR geprüft hat, kann diese*r auch Feedback über Kommentare mitteilen, wenn noch offene Issues oder Fragen vorliegen, die den Merge verhindern.

Verwenden Sie die Kommentarautomatisierung, um wichtige Aktionen im PR auszuführen. Mit der Kommentarautomatisierung können Benutzer*innen ihren PRs die entsprechende Bezeichnung zuweisen, um den Status zu aktualisieren oder zu kategorisieren. Wenn Sie in einem Repository arbeiten, in dem die Kommentarautomatisierung implementiert wurde, verwenden Sie die Hashtagkommentare, um Bezeichnungen zuzuweisen oder zu ändern, PRs zu schließen oder den Merge anzuhalten. Wenn Sie beispielsweise mit dem Vornehmen von Änderungen fertig sind, geben Sie den Kommentar #sign-off an, um Ihre PR-Bezeichnung von do-not-merge in ready-for-review. zu ändern.

Verwenden Sie die Kommentare in der folgenden Tabelle, um wichtige Aktionen in Ihrem PR auszuführen:

Sie müssen den Kommentar #sign-off eingeben, um Ihre Änderungen zu mergen. Selbst wenn alle Reviews und Validierungsprüfungen bestanden werden, sind Sie dafür verantwortlich, diesen Kommentar zu verwenden, um den PR-Reviewern und Repositoryadministratoren mitzuteilen, dass die Änderungen von Ihrer Seite aus bereit zum Mergen sind. Wenn die Reviewer*innen beschließen, dass Ihr PR fehlerfrei und freigegeben ist, werden Ihre Änderungen wieder mit dem übergeordneten Branch gemergt, und der PR wird geschlossen.

Veröffentlichung

Bedenken Sie, dass Ihr PR von einem oder einer PR-Reviewer*in gemergt werden muss, bevor die Änderungen in die nächste geplante Veröffentlichungsausführung aufgenommen werden können. Normalerweise werden PRs in der Reihenfolge der Übermittlung geprüft und gemergt.

Nachdem Ihre Beiträge genehmigt und gemergt wurden, werden sie vom Veröffentlichungsprozess erfasst. Je nach Team, das das Repository verwaltet, an dem Sie mitwirken, können die Veröffentlichungszeiten variieren. In der Regel erfolgt die Veröffentlichung jedoch mindestens einmal pro Wochentag. Es kann bis zu 45 Minuten dauern, bis Artikel nach der Veröffentlichung online angezeigt werden.

Sobald Ihre Änderungen veröffentlicht wurden, erscheinen sie auf Microsoft Learn. Dann können andere mit dem Lernen beginnen.

Szenario: Veröffentlichen von Änderungen in Azure App Service

Aufgrund Ihrer Erfahrung haben Sie eine Möglichkeit erkannt, nützliche Informationen zu einer App Service-Dokumentationsseite hinzuzufügen. Hierfür haben Sie einen PR erstellt. Sie sind nun bereit, Ihren PR prüfen zu lassen und freizugeben, um Ihre Bearbeitungen zu veröffentlichen.