Automatische PR-Entwürfe

Aktivieren Sie Automatische PR-Entwürfe unter Einstellungen > Automatisierungen, damit Fern ein Dokumentationsupdate als Entwurf erstellt, wenn ein gemergter Pull Request das für Kunden sichtbare Verhalten ändert. Sie prüfen jeden Entwurf weiterhin vor der Veröffentlichung oder Verwerfung; 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 in der Seitenleiste des Dashboards.
Wählen Sie Automatisierungen aus. Die Seite enthält Automatische PR-Entwürfe, Geplante Prüfungen und Kontinuierliche Verifizierung.
Aktivieren Sie Automatische PR-Entwürfe. Die Einstellung wird sofort gespeichert.

Wenn der Schalter aktiviert ist, werden darunter Empfindlichkeit und Anleitungen für PR-Entwürfe angezeigt.

Empfindlichkeit auswählen

Mit Empfindlichkeit legen Sie fest, wie schnell Fern aus einem gemergten Pull Request einen Entwurf erstellt. Wählen Sie eine Option aus:

Streng: nur eindeutige Änderungen: Fern erstellt nur dann einen Entwurf, wenn besonders klar ist, dass ein Dokumentationsupdate erforderlich ist.
Ausgewogen: die Standardeinstellung. Fern erstellt Entwürfe für eindeutige, für Kunden sichtbare Änderungen und überspringt weniger eindeutige Änderungen.
Proaktiv: mehr Entwürfe: Fern erstellt Entwürfe für ein breiteres Spektrum an für Kunden sichtbaren Änderungen.

Das Ändern der Auswahl wird sofort gespeichert.

Die Empfindlichkeit garantiert nicht für jede sichtbare Produktänderung einen Entwurf. Fern entscheidet weiterhin, ob der Merge dokumentiert werden muss, und wendet dann Ihre Empfindlichkeitseinstellung an, bevor eine Entwurfsaufgabe erstellt wird.

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

Verwenden Sie Anleitungen für PR-Entwürfe für dauerhafte, organisationsweite Anweisungen, die Fern beim Prüfen gemergter Pull Requests und beim Erstellen von Entwürfen daraus anwendet.

Das Feld akzeptiert bis zu 4.000 Zeichen. Verlassen Sie das Feld, um zu speichern. Durch Leeren des Felds 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. Anleitungen für PR-Entwürfe gelten 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 Produktionsbranch gemergt wurde. Wenn kein Produktionsbranch festgelegt ist, verwendet Fern den Standardbranch des Repositorys. Pull Requests, die in andere Branches gemergt werden, werden übersprungen. Pull Requests zum Rückgängigmachen von Änderungen werden ebenfalls übersprungen.

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

Fern erstellt einen Entwurf, wenn der Merge das für Kunden sichtbare Verhalten in einer Weise ändert, über die Kunden Bescheid wissen müssen, etwa bei UI-Abläufen, API-Endpunkten, dem Verhalten von Funktionen, Fehlermeldungen oder Konfigurationsoptionen, und die Änderung Ihre Empfindlichkeitseinstellung erfüllt.

Fern erstellt keinen Entwurf, wenn:

Die Änderung intern ist oder Endnutzer nicht betrifft
Die relevante Dokumentation bereits auf dem neuesten Stand ist
Die Änderung für Kunden sichtbar ist, aber Ihre aktuelle Empfindlichkeitseinstellung nicht erfüllt

In diesen Fällen erfasst Fern die Codeänderung trotzdem mit der Kennzeichnung Keine Dokumentationsänderungen erforderlich. Diese Threads werden standardmäßig nicht in der Liste Alle angezeigt. Filtern Sie die Fern-Seite nach Automatisierungen, um sie zu prüfen. Öffnen Sie einen Thread, um die Überschrift und eine eventuell von Fern gespeicherte Erklärung 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 prüfbare Aufgaben-Threads an und enthält daher möglicherweise nicht den PR-Thread zur Codeänderung 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 bereit ist, wählen Sie Änderungen prüfen und bearbeiten. Bearbeiten Sie den Entwurf, fordern Sie im Thread Überarbeitungen an oder veröffentlichen Sie ihn, wenn Sie zufrieden sind.

Sie steuern die Veröffentlichung

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

Einen Entwurf als nicht relevant verwerfen

Wenn ein Entwurf nicht auf Ihr Help Center zutrifft, markieren Sie ihn als Nicht relevant, um ihn aus Ihrem Feed zu entfernen, ohne ihn zu veröffentlichen. Sie können jeden geeigneten Entwurf verwerfen, der noch auf 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 können, 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. Eine verworfene Änderung wird mit Als nicht relevant verworfen und dem von Ihnen gespeicherten Grund angezeigt; Optionen zum Prüfen oder Veröffentlichen sind nicht verfügbar.