Aktualisiere die Dokumentation, wenn du einen Pull Request zusammenführst
Fern erstellt einen Entwurf für ein Help-Center-Update, wenn du einen Pull Request zusammenführst, durch den sich etwas ändert, das deine Kunden sehen. Jeder Entwurf wartet auf deine Prüfung. Fern veröffentlicht niemals selbst etwas.
Die Ferndesk GitHub App muss in deinen Repositories installiert sein. Inhaber und Admins können das ändern.
Aus welchen Pull Requests Fern Entwürfe erstellt
Neue Workspaces verwenden Änderungen für Nutzer. Um das 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 betreffen |
Änderungen für Nutzer | Alle Änderungen, die deine Kunden bemerken werden |
Jeder PR | Die größte Auswahl an Änderungen, einschließlich kleinerer Änderungen |
Aus | Nichts |
Bei jeder Einstellung erstellt Fern keine Entwürfe für Zusammenführungen, die keine Änderungen an der Dokumentation erfordern. Für dauerhaft geltende Regeln kannst du im selben Menü Filteranweisungen hinzufügen, zum Beispiel „PRs mit der Kennzeichnung chore oder refactor überspringen“.
Die Anmeldung mit GitHub allein 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 festlegst.
Wenn dein Standardbranch staging ist, deine Kunden aber den Inhalt von main erhalten, lege main als Produktionsbranch fest. Fern erstellt dann 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 für jedes Release eine Dokumentation 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 Änderung an der Dokumentation erfordert oder kleiner ist als durch deine Einstellung Entwürfe aus zusammengeführten PRs erstellen festgelegt, vermerkt Fern sie mit den entsprechenden Gründen als Keine Änderungen an der Dokumentation erforderlich. Wähle in Ferns Liste den Filter Automatisierungen, um diese Einträge zu sehen.
Was als PR-Prüfung zählt
Jeder zusammengeführte Pull Request, den Fern prüft, zählt als eine PR-Prüfung – unabhängig davon, ob Fern einen Entwurf erstellt. Dazu gehören Zusammenführungen, bei denen Fern entscheidet, dass keine Änderung an der Dokumentation erforderlich ist, Zusammenführungen, die durch deine Filteranweisungen übersprungen werden, und Zusammenführungen, die kleiner sind als durch deine Einstellung Entwürfe aus zusammengeführten PRs erstellen festgelegt. Zusammenführungen, die Fern nicht berücksichtigt (siehe oben), und Aufgaben, die du selbst startest, zählen nicht. Das Kontingent deines Tarifs findest du unter Nutzungslimits.
Wenn dein Kontingent für PR-Prüfungen aufgebraucht ist, prüft Fern keine Zusammenführungen mehr, bis das Kontingent zurückgesetzt wird oder du weitere Prüfungen kaufst. Zusammenführungen aus diesem Zeitraum werden später nicht geprüft. Inhaber und Admins können unter Einstellungen > Workspace > Nutzung ihre PR-Prüfungen einsehen und weitere kaufen.
Einen Entwurf prüfen
Jeder Entwurf erscheint in Fern als Thread zum zugehörigen 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 als „Nicht relevant“ markierter Thread verschwindet aus deiner Liste und bleibt über den Filter Automatisierungen verfügbar.
Wenn für eine Zusammenführung kein Entwurf erstellt wurde, findest du Hilfe unter Fehler bei Fern beheben.