Tieni il codice del tuo sito in GitHub
La sincronizzazione con GitHub conserva il codice del tuo sito in un repository GitHub, allineato in entrambe le direzioni. Ogni versione che va online diventa un commit nel repository, e un push sul branch collegato viene controllato, compilato e pubblicato sul tuo sito.
Cosa va su GitHub
Solo i file del tuo sito: quelli che mostra l'Esplora file e che contiene il suo download. Le parti condivise su cui gira ogni sito Briks, le impostazioni del sito, le tue chiavi e i record del tuo database non vanno mai lì. Per questo il repository non si compila né funziona da solo: Briks compila e pubblica ciò che invii.
| Cartella | Cosa contiene |
|---|---|
app/ | Le pagine del sito. |
components/custom/ | Le sezioni scritte per il tuo sito. |
content/ | Le parole e i fatti del sito. |
api/ | Il codice server del sito, se ne ha. |
db/schema.ts e db/data/ | La struttura dei dati del sito e i record con cui parte. |
public/ | Le immagini e i file del sito. |
Se il repository non ha un README, Briks ne aggiunge uno che spiega queste cartelle e come funziona la sincronizzazione.
Collega un repository
Premi Connect GitHub
Dove: Settings, GitHub
Si apre GitHub. Se l'app Briks non è ancora sul tuo account o sulla tua organizzazione GitHub, GitHub chiede dove installarla e quali repository può usare, poi ti rimanda indietro.
Scegli il repository e il branch
Dove: Settings, GitHub
Scegli l'account, poi il repository. Il branch parte da quello predefinito del repository; indicane un altro se vuoi, e uno che non esiste ancora viene creato dal branch predefinito. Create a repository on GitHub apre GitHub per crearne uno privato con il nome del tuo sito. Repository not listed? Give Briks access to it apre le impostazioni dell'app su GitHub.
Premi Connect
Dove: Settings, GitHub
Un branch vuoto viene collegato subito. Se il branch ha già dei file, Briks prima mostra quanti sono, quali si trovano nelle cartelle del tuo sito e cosa fa loro il suo primo commit. Premi Connect and commit this site per procedere, oppure Choose another.
Entro un paio di minuti, il primo commit porta la tua versione online. Sostituisce i file nelle cartelle del sito con quelli del sito e rimuove quelli che il sito non ha. Tutto il resto nel repository resta com'è. Dalla sua cronologia non si perde nulla, perché Briks non fa mai force-push.
Da Briks a GitHub
- Ogni versione che va online e modifica i file del tuo sito diventa un commit sul branch, comunque sia stata creata: una compilazione, una modifica, un salvataggio nel File Explorer o nel Visual Editor, o un ripristino. Mentre un test A/B è in corso, le sue versioni aspettano che finisca.
- Il messaggio del commit è il riepilogo che leggi nello studio, con il numero della versione e il nome di chi l'ha richiesta.
- GitHub mostra lo stato di ogni commit, ad esempio Live as version 15.
- Se un file contiene qualcosa che ha la forma di una chiave o nomina un servizio di Briks, non viene inviato nulla e ti viene detto quale file. Le chiavi vanno in Secrets.
Da GitHub a Briks
Un push sul branch collegato viene pubblicato sul tuo sito, senza IA e senza crediti. Prima passa lo stesso controllo di sicurezza di un salvataggio nel File Explorer: uno script, un frame o un modulo che raggiungerebbe un altro sito web viene rifiutato, a meno che tu non abbia aggiunto quel sito in Settings, Preferences, Allowed websites. Poi Briks lo costruisce e, entro un minuto o due, lo stato del commit riporta Live as version 16, oppure il motivo per cui non è stato pubblicato.
| Cosa cambia un push | Cosa succede |
|---|---|
File in app/, components/custom/, content/, api/, db/schema.ts, db/data/ o public/ | Pubblicato sul sito. |
Un README, una licenza e altri file nella radice del repository, e .github/ | Restano su GitHub. Non fanno mai parte del sito. |
db/migrations/ | Rifiutato. Briks scrive le modifiche dei dati a partire da db/schema.ts, quindi modifica lo schema. |
| Immagini e altri file che non sono testo | Rifiutate. Aggiungile tramite la libreria multimediale. Eliminarne una va bene. |
Qualsiasi altra cosa, come file di configurazione, file .env o un file che ha la forma di una chiave | Rifiutato, con il motivo indicato sul commit. Del push non viene pubblicato nulla. |
- Un push può modificare fino a 300 file, fino a 256 KB ciascuno e 8 MB in tutto.
- Per ogni sito vengono pubblicati fino a 20 push all'ora e 100 al giorno. Un push oltre il limite aspetta, e il suo stato su GitHub dice quando sarà pubblicato. I push che arrivano mentre uno aspetta vengono pubblicati insieme.
- Mentre un test A/B è in corso, un push attende che finisca.
Quando entrambe le parti hanno modificato lo stesso file
Un push che arriva mentre Briks sta pubblicando aspetta il suo turno. Se il push e Briks hanno modificato file diversi, vengono mantenuti entrambi. Se hanno modificato lo stesso file in modo diverso, del push non viene pubblicato nulla: Briks mette la propria versione su un branch chiamato briks-sync, e lo stato del push indica il file. Fai il merge di briks-sync su GitHub e fai di nuovo push, oppure risolvi in Settings, GitHub:
- Use GitHub's version pubblica l'intero push, compreso il file modificato da entrambe le parti.
- Keep Briks's version pubblica il push senza i file modificati da entrambe le parti.
Se la cronologia del branch viene riscritta, per esempio con un force-push, la sincronizzazione si ferma finché non scegli uno degli stessi due pulsanti.
Cosa ti viene comunicato
Le sincronizzazioni che vanno a buon fine sono silenziose, a parte il messaggio che un push è online. Un push non pubblicato, un push in attesa di un merge e un collegamento interrotto compaiono nella campanella, e nelle chat di Telegram e Discord che hanno attivo l'avviso Builds finished or failed. Settings, GitHub mostra le ultime 20 sincronizzazioni in entrambe le direzioni, ciascuna con il suo commit, i suoi file e il suo risultato.
Scollega
- Disconnect in Settings, GitHub ferma entrambe le direzioni. Il repository e la sua cronologia restano esattamente come sono.
- Spostare il progetto in un altro spazio di lavoro lo scollega.
- Se l'app viene disinstallata su GitHub, o il repository viene tolto dal suo accesso, la sincronizzazione si ferma e ne vieni informato.
- Eliminare il progetto non tocca mai il repository.
Posso iniziare un progetto da un repository che ho già?
Non ancora. L'importazione di un repository esistente non è disponibile. Crea il sito in Briks, poi collegagli un repository.
Posso eseguire il repository sul mio computer?
No. Contiene i file del tuo sito, non le parti condivise su cui gira ogni sito Briks, quindi non si compila da solo. Fai push delle modifiche, e Briks le compila e le pubblica.
Cosa può fare Briks sul mio account GitHub?
Solo ciò che l'app chiede quando la installi: leggere e scrivere i file dei repository che le indichi e impostare lo stato dei commit. Scrive solo sul branch che hai collegato e, quando entrambe le parti hanno modificato un file, su un branch briks-sync.
Briks legge i miei messaggi di commit?
No. Il registro di sincronizzazione mostra il commit di ogni push, i suoi file e chi l'ha fatto, mai il messaggio.