Automatische PR-Entwürfe

Aktivieren Sie Automatische PR-Entwürfe unter Einstellungen > Automatisierungen, damit Fern eine Dokumentationsaktualisierung als Entwurf erstellt, wenn ein zusammengeführter Pull Request das für Kunden sichtbare Verhalten ändert. Sie prüfen und veröffentlichen weiterhin jeden Entwurf; Fern veröffentlicht niemals automatisch.

Bevor Sie beginnen

Verbinden Sie die GitHub-Integration, damit Fern Pull Requests in Ihren Repositorys überwachen kann.

Automatische PR-Entwürfe aktivieren

Öffnen Sie Einstellungen über die Seitenleiste des Dashboards.
Wählen Sie Automatisierungen aus. Die Seite enthält Automatische PR-Entwürfe und Geplante Prüfungen.
Aktivieren Sie Automatische PR-Entwürfe. Die Einstellung wird sofort gespeichert.

Wenn der Schalter aktiviert ist, werden darunter Sensitivität und Anleitung für PR-Entwürfe angezeigt.

Sensitivität auswählen

Verwenden Sie Sensitivität, um festzulegen, wie schnell Fern aus einem zusammengeführten Pull Request einen Entwurf erstellt. Wählen Sie eine Option:

Streng: nur eindeutige Änderungen: Fern erstellt nur dann einen Entwurf, wenn die Notwendigkeit einer Dokumentationsaktualisierung besonders eindeutig ist.
Ausgewogen: die Standardeinstellung. Fern erstellt Entwürfe für eindeutige, für Kunden sichtbare Änderungen und überspringt weniger eindeutige Änderungen.
Großzügig: mehr Entwürfe: Fern erstellt Entwürfe für eine größere Auswahl an für Kunden sichtbaren Änderungen.

Das Ändern der Auswahl wird sofort gespeichert.

Die Sensitivität garantiert keinen Entwurf für jede sichtbare Produktänderung. Fern entscheidet weiterhin, ob für die Zusammenführung eine Dokumentation erforderlich ist, und wendet anschließend Ihre Sensitivitätseinstellung an, bevor eine Aufgabe zur Entwurfserstellung angelegt wird.

Anleitung für PR-Entwürfe hinzufügen

Verwenden Sie Anleitung für PR-Entwürfe für dauerhafte, organisationsweite Anweisungen, die Fern anwendet, wenn zusammengeführte Pull Requests geprüft und daraus Entwürfe erstellt werden.

Das Feld akzeptiert bis zu 4.000 Zeichen. Klicken Sie außerhalb des Felds, um zu speichern. Durch Leeren der Anleitung wird die Einstellung gelöscht.

Dieses Feld ist von den allgemeinen Fern-Anweisungen unter Einstellungen > Über Sie im Feld Unternehmensinformationen getrennt. Diese Anweisungen steuern Ferns allgemeines Schreiben und Recherchieren. Anleitung für PR-Entwürfe gilt nur für die PR-Prüfung und PR-basierten Entwürfe.

Was einen Entwurf auslöst

Fern erstellt einen Entwurf aus einem Pull Request, nachdem dieser in den für das Repository konfigurierten Produktions-Branch zusammengeführt wurde. Wenn kein Produktions-Branch festgelegt ist, verwendet Fern den Standard-Branch des Repositorys. Pull Requests, die in andere Branches zusammengeführt werden, werden übersprungen. Pull Requests zum Zurücksetzen von Änderungen werden ebenfalls übersprungen.

Legen Sie den Produktions-Branch für jedes Repository auf der Seite der GitHub-Integration fest.

Fern erstellt einen Entwurf, wenn die Zusammenführung das für Kunden sichtbare Verhalten ändert, über das Kunden informiert werden müssen, beispielsweise UI-Abläufe, API-Endpunkte, das Verhalten von Funktionen, Fehlermeldungen oder Konfigurationsoptionen, und die Änderung Ihre Sensitivitätseinstellung erfüllt.

Fern erstellt keinen Entwurf, wenn:

Die Änderung intern ist oder Endbenutzer nicht betrifft
Die relevante Dokumentation bereits aktuell ist
Die Änderung für Kunden sichtbar ist, aber Ihre aktuelle Sensitivitätseinstellung nicht erfüllt

In diesen Fällen erfasst Fern weiterhin eine Codeänderung mit der Kennzeichnung Keine Dokumentationsänderungen erforderlich. Diese Threads werden in der standardmäßigen Liste Alle nicht angezeigt. Filtern Sie die Fern-Seite nach Automatisierungen, um sie zu prüfen. Öffnen Sie einen Thread, um die Überschrift und alle von Fern gespeicherten Erläuterungen anzuzeigen.

Ihre Entwürfe prüfen

Wenn Fern einen Entwurf erstellt, erscheint er auf Ihrer Fern-Seite als Thread mit einem Pull-Request-Symbol. Der Thread zeigt den PR-Titel und Metadaten, eine Zusammenfassung der Änderungen sowie den Status des Entwurfs.

Um die Fern-Seite zu filtern, öffnen Sie Threads filtern in der Kopfzeile der Seitenleiste. Der Schalter Enthält Entwürfe zeigt dort nur überprüfbare Aufgaben-Threads an und enthält daher möglicherweise nicht den PR-Codeänderungs-Thread selbst. Öffnen Sie den PR-Thread direkt oder wählen Sie das Label Automatisierungen aus, um ihn zu finden.

Öffnen Sie den Thread. Wenn der Entwurf fertig ist, wählen Sie Änderungen prüfen und bearbeiten. Bearbeiten Sie den Entwurf, fordern Sie im Thread Überarbeitungen an oder veröffentlichen Sie ihn, sobald Sie zufrieden sind.

Sie bestimmen die Veröffentlichung

Fern erstellt Entwürfe für Aktualisierungen, veröffentlicht sie aber niemals automatisch. Jeder Entwurf muss von Ihnen geprüft werden, bevor er in Ihrem Hilfe-Center erscheint.

Entwurf als nicht relevant verwerfen

Wenn ein Entwurf nicht auf Ihr Hilfe-Center zutrifft, markieren Sie ihn als Nicht relevant, um ihn aus Ihrem Feed zu entfernen, ohne ihn zu veröffentlichen. Sie können jeden berechtigten Entwurf verwerfen, der noch auf die Prüfung wartet. Bereits veröffentlichte oder gerade veröffentlichte Änderungen können nicht verworfen werden.

Öffnen Sie den Entwurf auf Ihrer Fern-Seite.
Wählen Sie Nicht relevant aus.
Fügen Sie bei Bedarf einen Grund hinzu, damit Sie sich daran erinnern, warum der Entwurf nicht zutraf (optional).
Bestätigen Sie das Verwerfen.

Der Entwurf wird geschlossen und aus Ihrem Haupt-Feed von Fern entfernt. Er wird nicht gelöscht: Filtern Sie den Feed nach Automatisierungen, um verworfene Änderungen wiederzufinden. Bei einer verworfenen Änderung wird Als nicht relevant verworfen zusammen mit einem von Ihnen gespeicherten Grund angezeigt; Optionen zum Prüfen oder Veröffentlichen sind nicht verfügbar.