Mantenha o código do seu site no GitHub
A sincronização com o GitHub mantém o código do próprio site em um repositório do GitHub, nos dois sentidos. Cada versão que vai ao ar vira um commit lá, e um push na branch conectada é verificado, compilado e publicado no seu site.
O que vai para o GitHub
Só os arquivos do seu próprio site: os que o Explorador de Arquivos mostra e que o download dele contém. As partes compartilhadas em que todo site Briks funciona, as configurações do site, as suas chaves e os registros do seu banco de dados nunca vão para lá. Por isso o repositório não compila nem roda sozinho: o Briks compila e publica o que você enviar.
| Pasta | O que está incluído |
|---|---|
app/ | As páginas do site. |
components/custom/ | As seções escritas para o seu site. |
content/ | Os textos e os fatos do site. |
api/ | O código de servidor do próprio site, se houver. |
db/schema.ts e db/data/ | A estrutura dos dados do site e os registros com que ele começa. |
public/ | As imagens e os arquivos do próprio site. |
Se o repositório não tiver um README, o Briks adiciona um que explica essas pastas e como a sincronização funciona.
Conecte um repositório
Clique em Connect GitHub
Onde: Settings, GitHub
O GitHub abre. Se o app do Briks ainda não estiver na sua conta ou organização do GitHub, o GitHub pergunta onde instalá-lo e quais repositórios ele pode usar, e depois leva você de volta.
Escolha o repositório e a branch
Onde: Settings, GitHub
Escolha a conta e depois o repositório. A branch começa como a padrão do repositório; indique outra se quiser, e uma que ainda não existe é criada a partir da branch padrão. Create a repository on GitHub abre o GitHub para criar um repositório privado com o nome do seu site. Repository not listed? Give Briks access to it abre as configurações do app no GitHub.
Clique em Connect
Onde: Settings, GitHub
Um branch vazio é conectado na hora. Se o branch já tiver arquivos, o Briks mostra primeiro quantos são, quais estão nas pastas do seu site e o que o primeiro commit faz com eles. Clique em Connect and commit this site para seguir, ou em Choose another.
Em poucos minutos, o primeiro commit traz a sua versão publicada. Ele substitui os arquivos das pastas do seu site pelos do site e remove os que o site não tem. Todo o resto do repositório continua como está. Nada se perde do histórico, porque o Briks nunca faz force-push.
Do Briks para o GitHub
- Cada versão que entra no ar e altera os arquivos do seu site vira um commit na branch, seja qual for a origem: uma compilação, uma alteração, um salvamento no File Explorer ou no Visual Editor, ou uma restauração. Enquanto um teste A/B está em andamento, as versões dele esperam o fim do teste.
- A mensagem do commit é o resumo que você lê no estúdio, com o número da versão e o nome de quem a pediu.
- O GitHub mostra o status de cada commit, como Live as version 15.
- Se um arquivo contiver algo com formato de chave ou citar um dos serviços do próprio Briks, nada é enviado, e você é avisado de qual arquivo. As chaves pertencem a Secrets.
Do GitHub para o Briks
Um push para a branch conectada é publicado no seu site, sem IA e sem créditos. Primeiro ele passa pela mesma verificação de segurança de um salvamento no File Explorer: um script, frame ou formulário que alcançaria outro site é recusado, a menos que você tenha adicionado esse site em Settings, Preferences, Allowed websites. Depois a Briks o constrói e, em um ou dois minutos, o status do commit indica Live as version 16, ou o motivo de não ter sido publicado.
| O que um push altera | O que acontece |
|---|---|
Arquivos em app/, components/custom/, content/, api/, db/schema.ts, db/data/ ou public/ | Publicado no site. |
Um README, uma licença e outros arquivos na raiz do repositório, e .github/ | Ficam no GitHub. Nunca fazem parte do site. |
db/migrations/ | Recusado. O Briks escreve as mudanças dos dados a partir de db/schema.ts, então altere o schema. |
| Imagens e outros arquivos que não são texto | Recusado. Adicione-os pela biblioteca de mídia. Excluir um arquivo é permitido. |
Qualquer outra coisa, como arquivos de configuração, arquivos .env ou um arquivo com formato de chave | Recusado, com o motivo no commit. Nada do push é publicado. |
- Um push pode alterar até 300 arquivos, de até 256 KB cada e 8 MB no total.
- São publicados até 20 pushes por hora e 100 por dia para cada site. Um push acima do limite espera, e o status dele no GitHub informa quando será publicado. Os pushes que chegam enquanto um espera são publicados juntos.
- Enquanto um teste A/B está em andamento, o push espera ele terminar.
Quando os dois lados alteraram o mesmo arquivo
Um push que chega enquanto o Briks está publicando espera a sua vez. Se o push e o Briks alteraram arquivos diferentes, ambos são mantidos. Se alteraram o mesmo arquivo de formas diferentes, nada do push é publicado: o Briks coloca a própria versão em uma branch chamada briks-sync, e o status do push indica o arquivo. Faça o merge de briks-sync no GitHub e envie o push de novo, ou resolva em Settings, GitHub:
- Use GitHub's version publica o push inteiro, incluindo o arquivo que os dois lados alteraram.
- Keep Briks's version publica o push sem os arquivos que os dois lados alteraram.
Se o histórico da branch for reescrito, por exemplo por um force-push, a sincronização pausa até você escolher um dos mesmos dois botões.
O que você recebe de aviso
Sincronizações que funcionam são silenciosas, além da mensagem de que um push está no ar. Um push que não foi publicado, um push aguardando um merge e uma conexão que parou aparecem no sino e nos chats do Telegram e do Discord que têm o alerta Builds finished or failed ativado. Settings, GitHub mostra as últimas 20 sincronizações nos dois sentidos, cada uma com seu commit, seus arquivos e seu resultado.
Desconectar
- Disconnect em Settings, GitHub interrompe os dois sentidos. O repositório e o histórico dele ficam exatamente como estão.
- Mover o projeto para outro espaço de trabalho o desconecta.
- Se o app for desinstalado no GitHub, ou o repositório for removido do acesso dele, a sincronização para e você é avisado.
- Excluir o projeto nunca altera o repositório.
Posso começar um projeto a partir de um repositório que já tenho?
Ainda não. Importar um repositório existente não está disponível. Crie o site no Briks e depois conecte um repositório a ele.
Posso rodar o repositório no meu próprio computador?
Não. Ele guarda os arquivos do seu site, não as partes compartilhadas em que todo site do Briks funciona, então não compila sozinho. Envie suas alterações por push, e o Briks compila e publica.
O que o Briks pode fazer na minha conta do GitHub?
Somente o que o app pede quando você o instala: ler e gravar os arquivos dos repositórios que você indicar e definir o status dos commits. Ele grava apenas na branch que você conectou e, quando os dois lados alteraram um arquivo, em uma branch briks-sync.
O Briks lê as minhas mensagens de commit?
Não. O registro de sincronização mostra o commit de cada push, seus arquivos e quem o enviou, mas nunca a mensagem.