GitHub
GitHub é a maneira mais simples de hospedar um registro. Envie seus blocos para um repositório e use os URLs de conteúdo bruto do GitHub.
Configuração
Crie um repositório com esta estrutura:
acme-blocks/
registry.json
blocks/
hero/
block.json
index.php
card/
block.json
index.php
style.scss
registry.json
Defina baseUrl como o GitHub URL bruto do diretório blocks/:
{
"name": "acme",
"description": "Acme Corp block library.",
"baseUrl": "https://raw.githubusercontent.com/acme/acme-blocks/main/blocks",
"blocks": [
{
"name": "hero",
"title": "Hero",
"category": "layout",
"type": "blockstudio",
"files": ["block.json", "index.php"]
},
{
"name": "card",
"title": "Card",
"category": "components",
"type": "blockstudio",
"files": ["block.json", "index.php", "style.scss"]
}
]
}
O baseUrl usa raw.githubusercontent.com para que o CLI obtenha o conteúdo bruto do arquivo, e não a página GitHub HTML.
Configuração do consumidor
Os usuários adicionam o registro ao blocks.json:
{
"directory": "blockstudio",
"registries": {
"acme": "https://raw.githubusercontent.com/acme/acme-blocks/main/registry.json"
}
}
Em seguida:
npx blockstudio add acme/hero
Fixar uma versão
Para fixar uma versão específica, use uma tag ou SHA de commit em vez de main:
{
"registries": {
"acme": "https://raw.githubusercontent.com/acme/acme-blocks/v1.0.0/registry.json"
}
}
Isso evita que alterações incompatíveis afetem projetos existentes, desde que o registry.json nessa tag também use a tag em seu baseUrl. O CLI baixa arquivos de bloco de baseUrl, então um registry.json com tag cujo baseUrl ainda aponta para main instala os arquivos de main. O mesmo se aplica a um SHA de commit: ele fixa a lista de blocos, enquanto os arquivos vêm da referência indicada pelo baseUrl desse commit.
GitHub Pages
Você também pode servir um registro por GitHub Pages se preferir um URL mais limpo:
- Ative GitHub Pages para o repositório
- Defina
baseUrlcomo o URL do Pages:https://acme.github.io/acme-blocks/blocks - O
registry.jsonestará acessível emhttps://acme.github.io/acme-blocks/registry.json
Repositórios privados
Para repositórios privados, use o formato de registro de objetos com um token de acesso pessoal GitHub:
{
"registries": {
"private": {
"url": "https://raw.githubusercontent.com/acme/private-blocks/main/registry.json",
"headers": {
"Authorization": "Bearer ${GITHUB_TOKEN}"
}
}
}
}
Defina o token no ambiente:
export GITHUB_TOKEN=ghp_abc123
npx blockstudio add private/hero
O token precisa do escopo repo (ou contents:read para tokens de acesso refinado) para acessar o conteúdo de repositórios privados via raw.githubusercontent.com.