Dokumentation aktualisieren, wenn du einen Pull Request zusammenführst
Fern erstellt einen Entwurf für eine Aktualisierung des Help Centers, wenn du einen Pull Request zusammenführst, der etwas ändert, das deine Kunden sehen. Jeder Entwurf wartet auf deine Prüfung. Fern veröffentlicht niemals selbst.
Erfordert die Ferndesk GitHub App in deinen Repositories. Inhaber und Administratoren können diese Einstellung ändern.
Auswählen, für welche Pull Requests Fern Entwürfe erstellt
Neue Arbeitsbereiche verwenden standardmäßig Änderungen für Nutzer. Um die Einstellung zu ändern, gehe zu Fern > Anpassen > Automatisierungen und lege Entwürfe aus zusammengeführten PRs erstellen fest:
Option | Fern erstellt Entwürfe für |
|---|---|
Wichtige Funktionen | Nur die größten Änderungen, die Kunden sehen |
Änderungen für Nutzer | Alle Änderungen, die deinen Kunden auffallen |
Jede PR | Die größte Bandbreite an Änderungen, auch kleinere |
Aus | Keine |
Bei jeder Einstellung überspringt Fern Zusammenführungen, für die keine Dokumentationsänderung nötig ist. Für dauerhafte Regeln kannst du im selben Menü Filteranweisungen hinzufügen, zum Beispiel „PRs mit dem Label chore oder refactor überspringen“.
Die Anmeldung mit GitHub reicht nicht aus. Wenn die Ferndesk GitHub App nicht in deinen Repositories installiert ist, wird in der Einstellung angezeigt, dass sie noch nicht ausgeführt werden kann. Installiere die App über GitHub verbinden.
Welche Zusammenführungen Fern berücksichtigt
Zusammenführungen in den Produktionsbranch jedes Repositorys. Das ist der Standardbranch, sofern du auf der GitHub-Integrationsseite keinen Produktionsbranch für das Repository festgelegt hast.
Wenn dein Standardbranch staging ist, deine Kunden aber die Inhalte von main erhalten, lege main als Produktionsbranch fest. Fern erstellt dann nur einmal einen Entwurf, wenn der Release-Pull-Request in main zusammengeführt wird.
Nur Repositorys, für die auf derselben Seite die Dokumentation aktiviert ist.
Keine Reverts. Pull Requests, deren Titel mit „Revert“ beginnt, werden übersprungen.
Fern erstellt Entwürfe aus zusammengeführten Pull Requests, nicht aus GitHub-Releases oder Tags. Wenn du stattdessen die Dokumentation für jedes Release erstellen möchtest, setze Entwürfe aus zusammengeführten PRs erstellen auf Aus und bitte Fern beim Veröffentlichen eines Releases darum. Füge dazu die Release Notes hinzu.
Wenn eine Zusammenführung keine Dokumentationsänderung erfordert, vermerkt Fern sie mit den Gründen als Keine Dokumentationsänderungen erforderlich. Wähle in Ferns Liste den Filter Automatisierungen, um diese Einträge zu sehen.
Was als PR-Prüfung zählt
Für jeden Entwurf, den Fern auf Grundlage eines zusammengeführten Pull Requests erstellt, wird eine PR-Prüfung verwendet. Übersprungene Zusammenführungen und solche, für die Fern keine Dokumentationsänderung für nötig hält, verbrauchen keine PR-Prüfung. Auch Aufgaben, die du selbst startest, verbrauchen keine. Das Kontingent deines Plans findest du unter Nutzungslimits.
Wenn dein Kontingent an PR-Prüfungen aufgebraucht ist, erstellt Fern keine Entwürfe mehr aus Zusammenführungen, bis das Kontingent zurückgesetzt wird. Für diese Zusammenführungen wird später kein Entwurf erstellt. Sieh unter Einstellungen > Nutzung bei PR-Prüfungen nach.
Einen Entwurf prüfen
Jeder Entwurf wird in Fern als Thread für den zugehörigen Pull Request angezeigt, zusammen mit einer Zusammenfassung der Änderungen. Wähle Änderungen überprüfen und bearbeiten, um den Entwurf zu bearbeiten und zu veröffentlichen, oder Nicht relevant, wenn die Änderung nicht dokumentiert werden soll. Ein als „Nicht relevant“ markierter Thread verschwindet aus deiner Liste und bleibt unter dem Filter Automatisierungen verfügbar.
Wenn für eine Zusammenführung kein Entwurf erstellt wurde, findest du Hilfe unter Fehlerbehebung für Fern.