Dokumentation aktualisieren, wenn du einen Pull Request mergst
Fern erstellt einen Entwurf für ein Helpcenter-Update, wenn du einen Pull Request mergst, der etwas ändert, was deine Kunden sehen. Jeder Entwurf wartet auf deine Prüfung. Fern veröffentlicht niemals selbst Inhalte.
Erfordert die Ferndesk GitHub App in deinen Repositorys. Inhaber und Admins können diese Einstellung ändern.
Lege fest, für welche Pull Requests Fern Entwürfe erstellt
Neue Workspaces starten mit Änderungen für Nutzer. Um das zu ändern, gehe zu Fern > Anpassen > Automatisierungen und lege unter Entwürfe aus gemergten PRs erstellen Folgendes fest:
Option | Fern erstellt Entwürfe für |
|---|---|
Wichtige Funktionen | Nur die wichtigsten Änderungen, die Kunden betreffen |
Änderungen für Nutzer | Alle Änderungen, die deine Kunden bemerken werden |
Jeden PR | Die größte Auswahl an Änderungen, auch kleinere |
Aus | Nichts |
Bei jeder Einstellung erstellt Fern keine Entwürfe für Merges, die keine Dokumentationsänderung erfordern. Für dauerhafte Regeln kannst du im selben Menü Filteranweisungen hinzufügen, zum Beispiel „PRs mit den Labels chore oder refactor überspringen“.
Die Anmeldung mit GitHub reicht nicht aus. Wenn die Ferndesk GitHub App nicht in deinen Repositorys installiert ist, wird in der Einstellung angezeigt, dass sie noch nicht ausgeführt werden kann. Installiere die App über GitHub verbinden.
Welche Merges Fern berücksichtigt
Merges 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 den Inhalt von main erhalten, lege main als Produktionsbranch fest. Fern erstellt dann nur einen Entwurf, wenn der Release-Pull-Request in main gemergt 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 gemergten Pull Requests, nicht aus GitHub-Releases oder Tags. Wenn du stattdessen die Dokumentation für jedes Release erstellen möchtest, setze Entwürfe aus gemergten PRs erstellen auf Aus und bitte Fern beim Veröffentlichen eines Releases darum. Hänge dazu die Release Notes an.
Wenn ein Merge keine Dokumentationsänderung erfordert oder kleiner ist als deine Einstellung für Entwürfe aus gemergten PRs erstellen, vermerkt Fern ihn mit der Begründung als Keine Dokumentationsänderungen erforderlich. Wähle den Filter Automatisierungen in der Liste von Fern aus, um diese Einträge zu sehen.
Was als PR-Prüfung zählt
Jeder gemergte Pull Request, den Fern prüft, verbraucht eine PR-Prüfung – unabhängig davon, ob Fern einen Entwurf erstellt. Dazu gehören Merges, bei denen Fern entscheidet, dass keine Dokumentationsänderung nötig ist, Merges, die durch deine Filteranweisungen übersprungen werden, und Merges, die kleiner sind als deine Einstellung für Entwürfe aus gemergten PRs erstellen. Merges, die Fern nicht berücksichtigt (siehe oben), und Aufgaben, die du selbst startest, verbrauchen keine PR-Prüfung. Das Kontingent deines Tarifs findest du unter Nutzungslimits.
Wenn dein Kontingent für PR-Prüfungen aufgebraucht ist, prüft Fern keine Merges mehr, bis das Kontingent zurückgesetzt wird oder du weitere PR-Prüfungen kaufst. Merges aus diesem Zeitraum werden nicht nachträglich geprüft. Inhaber und Admins können unter Einstellungen > Workspace > Nutzung die PR-Prüfungen einsehen und weitere kaufen.
Einen Entwurf prüfen
Jeder Entwurf erscheint in Fern als Thread zugehörig zu seinem Pull Request und enthält eine Zusammenfassung der Änderungen. Wähle Änderungen prüfen und bearbeiten, um den Entwurf zu bearbeiten und zu veröffentlichen, oder Nicht relevant, wenn die Änderung nicht dokumentiert werden soll. Ein Thread, der als „Nicht relevant“ markiert ist, verschwindet aus deiner Liste und bleibt unter dem Filter Automatisierungen verfügbar.
Wenn für einen Merge kein Entwurf erstellt wurde, findest du Hilfe unter Fern-Probleme beheben.