Integration
Formfeed für GitHub Actions
Vorlagen, die als Dateien in einem Repository liegen, verdienen die Sorgfalt, die Code bekommt: Ein Pull Request, der eine davon zerbricht, sollte vor dem Merge scheitern, und wer ihn prüft, sollte das Dokument sehen, nicht einen Diff seines HTML. Die Action führt die Kommandozeile von Formfeed in Ihrem Workflow aus, erledigt beides und veröffentlicht dann vom Standard-Branch aus.
Im GitHub Marketplace als Formfeed templates (formfeed-dev/formfeed-action).
Kostenloser Plan mit 100 Einheiten im Monat, keine Kreditkarte
Ein Schritt in Ihrem Workflow
Fügen Sie die Action einem Workflow hinzu, der bei Pull Requests und bei Pushes auf Ihren Standard-Branch läuft. Mit einem Test-Schlüssel rendert sie die Vorschauen kostenlos, und ein zweiter Schritt mit einem Live-Schlüssel veröffentlicht. Den ganzen Workflow und jede Eingabe zeigt die Dokumentation, und GitHub führt die Action auf ihrer Marketplace-Seite.
steps:
- uses: actions/checkout@v4
- uses: formfeed-dev/formfeed-action@v1
with:
api-key: ${{ secrets.FORMFEED_TEST_KEY }}
- if: github.event_name == 'push'
uses: formfeed-dev/formfeed-action@v1
with:
api-key: ${{ secrets.FORMFEED_LIVE_KEY }}
validate: false
test: false
publish: trueWas jeder Lauf tut
- Er validiert jede Vorlage: ihre Syntax, Variablen, die ihr Standard-Datensatz nicht hat, Kopf- und Fußzeile, Partials, die dem Projekt fehlen, und bei einer Rechnungsvorlage den
_invoice-Block jedes Datensatzes. Offline, ohne Schlüssel. - Er testet jeden Datensatz gegen seinen freigegebenen Snapshot, sodass eine Änderung an einem gemeinsamen Partial oder einem Stil, die eine andere Vorlage verschiebt, als gescheiterte Prüfung erscheint.
- Er rendert die Vorlagen, die ein Pull Request ändert, über die API (jede Vorlage, wenn sich ein Partial geändert hat), lädt die Dateien als Artefakt hoch und hält einen Kommentar am Pull Request mit der Seitenzahl jedes Dokuments aktuell.
- Er veröffentlicht auf dem Standard-Branch eine neue Version jeder Vorlage des Projekts oder pusht in einen Release Channel, um eine Änderung zu prüfen, bevor sie live geht.
Gut zu wissen, bevor Sie sie einbinden
- Verwenden Sie für Pull Requests einen Test-Schlüssel: Seine Renderings kosten nichts, und seine Dateien werden nach einem Tag gelöscht. Der Schritt, der veröffentlicht, braucht einen Schlüssel mit
template:writeund nicht mehr. - Der Kommentar braucht
pull-requests: writein den Berechtigungen des Jobs; ohne sie warnt die Action, und die Vorschauen liegen trotzdem im Artefakt. - Pull Requests aus Forks laufen ohne Ihre Secrets; sie werden validiert und getestet, aber nicht als Vorschau gerendert.
- Die Action führt die veröffentlichte Kommandozeile
formfeedaus; ihre Eingabeversionlegt die fest, die Sie getestet haben.