GitHub
GitHub este cea mai simplă modalitate de a găzdui un registru. Încărcați blocurile într-un depozit și folosiți URL-urile de conținut brut ale GitHub.
Configurare
Creați un depozit cu această structură:
acme-blocks/
registry.json
blocks/
hero/
block.json
index.php
card/
block.json
index.php
style.scss
registry.json
Setați baseUrl la GitHub brut URL pentru directorul 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"]
}
]
}
baseUrl folosește raw.githubusercontent.com astfel încât CLI să primească conținutul brut al fișierului, nu pagina GitHub HTML.
Configurația consumatorului
Utilizatorii adaugă registrul în blocks.json:
{
"directory": "blockstudio",
"registries": {
"acme": "https://raw.githubusercontent.com/acme/acme-blocks/main/registry.json"
}
}
Apoi:
npx blockstudio add acme/hero
Fixarea la o versiune
Pentru a fixa o anumită versiune, folosiți o etichetă sau un SHA de commit în loc de main:
{
"registries": {
"acme": "https://raw.githubusercontent.com/acme/acme-blocks/v1.0.0/registry.json"
}
}
Astfel, modificările incompatibile nu vor afecta proiectele existente, atât timp cât registry.json de la acea etichetă folosește și eticheta în baseUrl. CLI descarcă fișierele blocurilor din baseUrl, așa că un registry.json etichetat al cărui baseUrl indică încă spre main instalează fișierele din main. Același lucru este valabil pentru un SHA de commit: acesta fixează lista blocurilor, iar fișierele provin din referința indicată de baseUrl acelui commit.
GitHub Pages
De asemenea, puteți servi un registru prin GitHub Pages dacă preferați un URL mai simplu:
- Activați GitHub Pages pentru depozit
- Setați
baseUrlla URL Pages:https://acme.github.io/acme-blocks/blocks registry.jsoneste accesibil lahttps://acme.github.io/acme-blocks/registry.json
Depozite private
Pentru depozitele private, folosiți formatul de registru cu obiect și un token personal de acces GitHub:
{
"registries": {
"private": {
"url": "https://raw.githubusercontent.com/acme/private-blocks/main/registry.json",
"headers": {
"Authorization": "Bearer ${GITHUB_TOKEN}"
}
}
}
}
Setați tokenul în mediul de execuție:
export GITHUB_TOKEN=ghp_abc123
npx blockstudio add private/hero
Tokenul are nevoie de domeniul de acces repo (sau de contents:read pentru tokenurile cu permisiuni granulare) pentru a accesa conținutul depozitelor private prin raw.githubusercontent.com.