Automatische PR-Entwürfe
Aktiviere Automatische PR-Entwürfe unter Einstellungen > Automatisierungen, damit Fern einen Docs-Update-Entwurf erstellt, wenn ein zusammengeführter Pull Request das kundenrelevante Verhalten ändert. Du prüfst und veröffentlichst trotzdem jeden Entwurf; Fern veröffentlicht niemals automatisch.
Vorbereitung
Verbinde die GitHub-Integration, damit Fern Pull Requests in deinen Repositories überwachen kann.
Automatische PR-Entwürfe aktivieren
Öffne Einstellungen in der Seitenleiste des Dashboards.
Wähle Automatisierungen aus. Auf der Seite findest du Automatische PR-Entwürfe und Geplante Audits.
Aktiviere Automatische PR-Entwürfe. Die Einstellung wird sofort gespeichert.
Wenn der Schalter aktiviert ist, werden darunter Empfindlichkeit und Anleitung für PR-Entwürfe angezeigt.
Empfindlichkeit auswählen
Verwende Empfindlichkeit, um zu steuern, wie bereitwillig Fern aus einem zusammengeführten Pull Request einen Entwurf erstellt. Wähle eine Option:
Streng: nur eindeutige Änderungen: Fern erstellt nur dann Entwürfe, wenn die Notwendigkeit eines Docs-Updates besonders eindeutig ist.
Ausgewogen: die Standardeinstellung. Fern erstellt Entwürfe für klare kundenrelevante Änderungen und überspringt schwächere Fälle.
Vorausschauend: mehr Entwürfe: Fern erstellt Entwürfe für einen breiteren Satz kundenrelevanter Änderungen.
Die Änderung des Auswahlmenüs wird sofort gespeichert.
Die Empfindlichkeit garantiert nicht für jede sichtbare Produktänderung einen Entwurf. Fern entscheidet weiterhin, ob der Merge Dokumentation erfordert, und wendet dann deine Empfindlichkeits-Einstellung an, bevor ein Entwurfsauftrag erstellt wird.
Anleitung für PR-Entwürfe hinzufügen
Verwende Anleitung für PR-Entwürfe für dauerhafte, organisationsweite Anweisungen, die Fern anwendet, wenn es zusammengeführte Pull Requests prüft und daraus Entwürfe erstellt.
Das Feld akzeptiert bis zu 4.000 Zeichen. Verlasse das Feld, um zu speichern. Leere Hinweise setzen die Einstellung zurück.
Dieses Feld ist getrennt von den organisationsweiten Anleitungen für Entwürfe und den Recherche-Anweisungen unter Einstellungen > Fern. Diese steuern Ferns allgemeines Schreiben und die Recherche. Anleitung für PR-Entwürfe gilt nur für die Prüfung von PRs und PR-basierte Entwürfe.
Was einen Entwurf auslöst
Fern erstellt aus einem Pull Request einen Entwurf, nachdem er in den konfigurierten Produktions-Branch des Repositories zusammengeführt wurde. Wenn kein Produktions-Branch festgelegt ist, verwendet Fern den Standard-Branch des Repositories. Pull Requests, die in andere Branches zusammengeführt werden, werden übersprungen. Auch Revert-Pull-Requests werden übersprungen.
Lege den Produktions-Branch für jedes Repository auf der Seite der GitHub-Integration fest.
Fern erstellt einen Entwurf, wenn der Merge das kundenrelevante Verhalten ändert, das Kunden kennen müssen, etwa UI-Abläufe, API-Endpunkte, Funktionsverhalten, Fehlermeldungen oder Konfigurationsoptionen, und die Änderung deine Empfindlichkeits-Einstellung erfüllt.
Fern erstellt keinen Entwurf, wenn:
Die Änderung intern ist oder Endnutzer nicht betrifft
Die relevante Dokumentation bereits aktuell ist
Die Änderung kundenrelevant ist, aber deine aktuelle Empfindlichkeits-Einstellung nicht erfüllt
In diesen Fällen erfasst Fern trotzdem eine Codeänderung mit der Kennzeichnung Keine Dokumentationsänderungen erforderlich. Diese Threads bleiben aus der standardmäßigen Liste Alle heraus. Filtere die Fern-Seite nach Automatisierungen, um sie zu prüfen. Öffne einen Thread, um die Überschrift und alle von Fern gespeicherten Erklärungen zu sehen.
Entwürfe prüfen
Wenn Fern einen Entwurf erstellt, erscheint er auf deiner Fern-Seite als Thread mit einem Pull-Request-Symbol. Der Thread zeigt den PR-Titel und Metadaten, eine Zusammenfassung der Änderungen und den Entwurfsstatus.
Öffne den Thread. Wenn der Entwurf bereit ist, wähle Änderungen prüfen und bearbeiten. Bearbeite den Entwurf, fordere im Thread Überarbeitungen an oder veröffentliche ihn, wenn du zufrieden bist.
Filtere die Fern-Thread-Liste mit Hat Entwürfe, um nur Threads zu sehen, für die Entwurfsaktualisierungen zur Prüfung bereitstehen.
Du kontrollierst die Veröffentlichung
Fern erstellt Entwürfe, veröffentlicht sie aber niemals automatisch. Jeder Entwurf muss von dir geprüft werden, bevor er in deinem Hilfecenter erscheint.