Anteprima dei database per richiesta pull
Un ramo è una copia di un progetto con il proprio URL e chiavi API. Creane una per richiesta pull in CI, punta l'anteprima su di essa e lasciala scadere o eliminala al momento dell'unione.
Una richiesta pull = un database#
aura branch create clona un progetto PostgreSQL (schema, policy di sicurezza a livello di riga, funzioni, trigger, viste e righe) in un nuovo progetto con il proprio URL e chiavi API. Una richiesta pull può eseguire la migrazione lì e i revisori possono provare il risultato, senza alcun conflitto sul progetto di origine. L'elenco completo di ciò che è e non è clonato, e i limiti, si trovano nei rami del database branch di database.
Un ramo è una copia effettuata al momento della creazione, in un tempo proporzionale ai dati (14 secondi per 333 MB sullo stack di test locale). Non è un clone copy-on-write e non segue successivamente l'origine.
Nel CI#
Non c'è alcuna azione GitHub da installare: la CLI fa il lavoro. Autenticati con un token di accesso personale (aura login --token), quindi crea il ramo dal progetto su cui esegui il test e mantieni ciò di cui ha bisogno l'anteprima. Salva ogni snippet come script della tua pipeline:
aura login --token "$AURA_PAT"
aura branch create "pr-$PR_NUMBER" --from "$AURA_PROJECT_ID" --ttl 3d --json > branch.json
# branch.json: id, slug, url, anon_key, service_role_key, scade_at
aura login --token "$AURA_PAT"
aura branch delete "pr-$PR_NUMBER" --from "$AURA_PROJECT_ID" --force
Le chiavi vengono stampate una sola volta, al momento della creazione del ramo: in quel momento salvale nel lavoro (o come segreti del deploy di anteprima). Per eseguire le migrazioni della richiesta pull sul ramo, collegare la cartella ad esso e inviare: aura link --project-id <branch id> quindi aura db push.
I comandi aura branch sono stati eseguiti su uno stack locale; aura login --token è l'accesso delle ricette CI nella distribuzione deployment. Il flusso di lavoro GitHub o GitLab attorno a loro è tuo e puoi scriverlo.
Cosa contiene il ramo#
Il ramo ha le righe della sorgente (aggiungere --no-data solo per lo schema), inclusi eventuali dati personali in loro possesso: non è prevista l'anonimizzazione. Creare il ramo da un progetto di staging, non da produzione, se l'anteprima non deve vedere dati reali. Gli utenti di autenticazione, gli oggetti di archiviazione, le funzioni edge e i segreti non vengono clonati; seminali nella configurazione di anteprima.
TTL e quote#
Per impostazione predefinita, un ramo dura 72 ore, fino a 30 giorni (--ttl). I rami scaduti vengono eliminati automaticamente, così come un ramo la cui creazione non riesce. Un ramo non conta ai fini del limite del progetto; conta rispetto al limite di rami attivi del tuo piano (1 su Free, 10 su Pro, 25 su Team), vedi limiti. Superato il limite, aura branch create fallisce con BRANCH_LIMIT_REACHED: elimina un ramo o attendi il suo TTL.