GitHub
GitHub on lihtsaim viis registri majutamiseks. Lükake oma plokid hoidlasse ja kasutage GitHub toorsisu URL-e.
Seadistamine
Looge sellise struktuuriga hoidla:
acme-blocks/
registry.json
blocks/
hero/
block.json
index.php
card/
block.json
index.php
style.scss
registry.json
Määrake baseUrl oma blocks/ kataloogi toore GitHub URL-ks:
{
"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 kasutab raw.githubusercontent.com, et CLI saaks faili toorsisu, mitte GitHub HTML lehte.
Tarbija seadistus
Kasutajad lisavad teie registri oma blocks.json-i:
{
"directory": "blockstudio",
"registries": {
"acme": "https://raw.githubusercontent.com/acme/acme-blocks/main/registry.json"
}
}
Seejärel:
npx blockstudio add acme/hero
Väljalaskega sidumine
Kindla versiooni kasutamiseks kasutage märgendit või sissekande SHA-d, mitte main:
{
"registries": {
"acme": "https://raw.githubusercontent.com/acme/acme-blocks/v1.0.0/registry.json"
}
}
See väldib olemasolevaid projekte mõjutavaid ühildumatuid muudatusi, kui selle märgendi registry.json kasutab samuti oma baseUrl-is seda märgendit. CLI laadib plokifailid asukohast baseUrl, seega installib märgendatud registry.json, mille baseUrl osutab endiselt asukohale main, failid asukohast main. Sama kehtib sissekande SHA puhul: see fikseerib plokkide loendi, failid aga hangitakse viite põhjal, millele selle sissekande baseUrl osutab.
GitHub Pages
Soovi korral saate registrit pakkuda ka GitHub Pages kaudu, et kasutada puhtamat URL:
- Lubage hoidla jaoks GitHub Pages
- Määrake
baseUrloma Pagesi URL-ks:https://acme.github.io/acme-blocks/blocks registry.jsonon saadaval aadressilhttps://acme.github.io/acme-blocks/registry.json
Privaatsed hoidlad
Privaatsete hoidlate puhul kasutage objektregistri vormingut koos GitHub isikliku juurdepääsutõendiga:
{
"registries": {
"private": {
"url": "https://raw.githubusercontent.com/acme/private-blocks/main/registry.json",
"headers": {
"Authorization": "Bearer ${GITHUB_TOKEN}"
}
}
}
}
Määrake tõend keskkonnamuutujana:
export GITHUB_TOKEN=ghp_abc123
npx blockstudio add private/hero
Privaatse hoidla sisu hankimiseks raw.githubusercontent.com kaudu vajab tõend õigust repo (või õigust contents:read peenhäälestatud õigustega tõendite puhul).