Den Code Ihrer Website in GitHub aufbewahren
Der GitHub-Sync hält den eigenen Code Ihrer Website in einem GitHub-Repository, in beide Richtungen abgeglichen. Jede Version, die live geht, wird dort zu einem Commit, und ein Push auf den verbundenen Branch wird geprüft, gebaut und auf Ihrer Website veröffentlicht.
Was an GitHub gesendet wird
Nur die eigenen Dateien Ihrer Website: die, die der Datei-Explorer zeigt und die sein Download enthält. Die gemeinsamen Teile, auf denen jede Briks-Website läuft, die Einstellungen der Website, Ihre Schlüssel und die Datensätze Ihrer Datenbank gelangen nie dorthin. Das Repository lässt sich also nicht von allein bauen oder ausführen: Briks erstellt und veröffentlicht, was Sie pushen.
| Ordner | Was enthalten ist |
|---|---|
app/ | Die Seiten der Website. |
components/custom/ | Die für Ihre Website geschriebenen Abschnitte. |
content/ | Die Texte und Fakten der Website. |
api/ | Der eigene Servercode der Website, falls sie welchen hat. |
db/schema.ts und db/data/ | Die Struktur der Daten der Website und die Datensätze, mit denen sie startet. |
public/ | Die eigenen Bilder und Dateien der Website. |
Hat das Repository keine README, legt Briks eine an, die diese Ordner und die Funktionsweise der Synchronisierung erklärt.
Repository verbinden
Auf Connect GitHub klicken
Wo: Settings, GitHub
GitHub öffnet sich. Ist die Briks-App in Ihrem GitHub-Konto oder Ihrer Organisation noch nicht installiert, fragt GitHub, wo sie installiert werden soll und welche Repositories sie nutzen darf, und leitet Sie dann zurück.
Repository und Branch wählen
Wo: Settings, GitHub
Wählen Sie das Konto, dann das Repository. Der Branch beginnt als Standard-Branch des Repositorys; nennen Sie einen anderen, wenn Sie möchten, und einer, den es noch nicht gibt, wird aus dem Standard-Branch angelegt. Create a repository on GitHub öffnet GitHub, um ein privates nach Ihrer Website benanntes anzulegen. Repository not listed? Give Briks access to it öffnet die Einstellungen der App auf GitHub.
Auf Connect drücken
Wo: Settings, GitHub
Ein leerer Branch wird sofort verbunden. Hat der Branch bereits Dateien, zeigt Briks zuerst, wie viele es sind, welche davon in den Ordnern Ihrer Website liegen und was der erste Commit mit ihnen macht. Drücken Sie Connect and commit this site, um fortzufahren, oder Choose another.
Innerhalb weniger Minuten bringt der erste Commit Ihre Live-Version. Er ersetzt die Dateien in den Ordnern Ihrer Website durch die der Website und entfernt die, die die Website nicht hat. Alles andere im Repository bleibt, wie es ist. Aus dem Verlauf geht nichts verloren, denn Briks führt nie einen Force-Push aus.
Von Briks zu GitHub
- Jede Version, die live geht und die Dateien Ihrer Website ändert, wird zu einem Commit im Branch, gleich wie sie entstanden ist: durch einen Build, eine Änderung, eine Speicherung im File Explorer oder im Visual Editor oder eine Wiederherstellung. Solange ein A/B-Test läuft, warten seine Versionen, bis er endet.
- Die Nachricht des Commits ist die Zusammenfassung, die Sie im Studio lesen, mit der Nummer der Version und dem Namen der Person, die sie angefragt hat.
- GitHub zeigt den Status jedes Commits, etwa Live as version 15.
- Enthält eine Datei etwas, das wie ein Schlüssel aussieht oder einen eigenen Dienst von Briks nennt, wird nichts gesendet, und Sie erfahren, welche Datei es ist. Schlüssel gehören in Secrets.
Von GitHub zu Briks
Ein Push auf den verbundenen Branch wird auf Ihrer Website veröffentlicht, ohne KI und ohne Credits. Zuerst durchläuft er dieselbe Sicherheitsprüfung wie ein Speichern im File Explorer: Ein Skript, Frame oder Formular, das eine andere Website erreichen würde, wird abgelehnt, es sei denn, Sie haben diese Website unter Settings, Preferences, Allowed websites hinzugefügt. Dann erstellt Briks es, und innerhalb ein bis zwei Minuten zeigt der Status des Commits Live as version 16 oder den Grund, warum nicht veröffentlicht wurde.
| Was ein Push ändert | Was passiert |
|---|---|
Dateien in app/, components/custom/, content/, api/, db/schema.ts, db/data/ oder public/ | Auf der Website veröffentlicht. |
Eine README, eine Lizenz und weitere Dateien im Stammverzeichnis des Repositorys sowie .github/ | Bleiben in GitHub. Sie sind nie Teil der Website. |
db/migrations/ | Abgelehnt. Briks schreibt die Änderungen der Daten aus db/schema.ts, ändern Sie daher stattdessen das Schema. |
| Bilder und andere Dateien, die kein Text sind | Abgelehnt. Fügen Sie sie über die Medienbibliothek hinzu. Löschen ist in Ordnung. |
Alles andere, etwa Konfigurationsdateien, .env-Dateien oder eine Datei, die wie ein Schlüssel aussieht | Abgelehnt, mit dem Grund am Commit. Vom Push wird nichts veröffentlicht. |
- Ein Push kann bis zu 300 Dateien ändern, jede bis zu 256 KB und insgesamt bis zu 8 MB.
- Pro Website werden bis zu 20 Pushes pro Stunde und 100 pro Tag veröffentlicht. Ein Push über dem Limit wartet, und sein Status auf GitHub nennt den Zeitpunkt der Veröffentlichung. Pushes, die eintreffen, während einer wartet, werden gemeinsam veröffentlicht.
- Solange ein A/B-Test läuft, wartet ein Push auf dessen Ende.
Wenn beide Seiten dieselbe Datei geändert haben
Ein Push, der eintrifft, während Briks veröffentlicht, wartet, bis er an der Reihe ist. Haben der Push und Briks verschiedene Dateien geändert, bleiben beide erhalten. Haben sie dieselbe Datei unterschiedlich geändert, wird nichts vom Push veröffentlicht: Briks legt seine eigene Version in einem Branch namens briks-sync ab, und der Status des Pushs nennt die Datei. Führen Sie briks-sync auf GitHub zusammen und pushen Sie erneut, oder klären Sie es unter Settings, GitHub:
- Use GitHub's version veröffentlicht den gesamten Push, auch die Datei, die beide Seiten geändert haben.
- Keep Briks's version veröffentlicht den Push ohne die Dateien, die beide Seiten geändert haben.
Wird der Verlauf des Branches umgeschrieben, zum Beispiel durch einen Force-Push, pausiert die Synchronisierung, bis Sie einen der beiden gleichen Buttons wählen.
Was Sie erfahren
Synchronisierungen, die klappen, bleiben still, abgesehen von der Nachricht, dass ein Push live ist. Ein Push, der nicht veröffentlicht wurde, ein Push, der auf einen Merge wartet, und eine unterbrochene Verbindung erscheinen in der Glocke sowie in Telegram- und Discord-Chats, in denen die Meldung Builds finished or failed eingeschaltet ist. Settings, GitHub zeigt die letzten 20 Synchronisierungen in beide Richtungen, jeweils mit Commit, Dateien und Ergebnis.
Trennen
- Disconnect unter Settings, GitHub stoppt beide Richtungen. Das Repository und sein Verlauf bleiben genau so, wie sie sind.
- Wird das Projekt in ein anderes Workspace verschoben, wird die Verbindung getrennt.
- Wird die App auf GitHub deinstalliert oder das Repository aus ihrem Zugriff genommen, endet der Abgleich, und Sie werden benachrichtigt.
- Das Löschen des Projekts berührt das Repository nie.
Kann ich ein Projekt aus einem bereits vorhandenen Repository starten?
Noch nicht. Ein vorhandenes Repository zu importieren ist nicht möglich. Erstellen Sie die Website in Briks und verbinden Sie dann ein Repository damit.
Kann ich das Repository auf meinem eigenen Computer ausführen?
Nein. Es enthält die eigenen Dateien Ihrer Website, nicht die gemeinsamen Teile, auf denen jede Briks-Website läuft, und lässt sich daher nicht von allein bauen. Pushen Sie Ihre Änderungen, dann baut und veröffentlicht Briks sie.
Was kann Briks in meinem GitHub-Konto tun?
Nur das, was die App bei der Installation anfragt: die Dateien der Repositories lesen und schreiben, die Sie ihr freigeben, und den Status von Commits setzen. Sie schreibt nur in den Branch, den Sie verbunden haben, und, wenn beide Seiten eine Datei geändert haben, in einen briks-sync-Branch.
Liest Briks meine Commit-Nachrichten?
Nein. Das Sync-Protokoll zeigt zu jedem Push den Commit, seine Dateien und wer ihn gepusht hat, aber nie die Nachricht.