GitHub
GitHub ir vienkāršākais veids, kā mitināt reģistru. Ievietojiet savus blokus repozitorijā un izmantojiet GitHub neapstrādātā satura URL.
Iestatīšana
Izveidojiet repozitoriju ar šādu struktūru:
acme-blocks/
registry.json
blocks/
hero/
block.json
index.php
card/
block.json
index.php
style.scss
registry.json
Iestatiet baseUrl uz neapstrādātā GitHub URL jūsu blocks/ direktorijam:
{
"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 izmanto raw.githubusercontent.com, lai CLI iegūtu neapstrādātu faila saturu, nevis GitHub HTML lapu.
Patērētāja konfigurācija
Lietotāji pievieno jūsu reģistru savam blocks.json:
{
"directory": "blockstudio",
"registries": {
"acme": "https://raw.githubusercontent.com/acme/acme-blocks/main/registry.json"
}
}
Pēc tam:
npx blockstudio add acme/hero
Piesaiste laidienam
Lai piesaistītu konkrētai versijai, main vietā izmantojiet tagu vai commit SHA:
{
"registries": {
"acme": "https://raw.githubusercontent.com/acme/acme-blocks/v1.0.0/registry.json"
}
}
Tas neļauj nesaderīgām izmaiņām ietekmēt esošos projektus, ja vien registry.json šajā tagā arī izmanto tagu savā baseUrl. CLI lejupielādē bloku failus no baseUrl, tāpēc marķēts registry.json, kura baseUrl joprojām norāda uz main, instalē failus no main. Tas pats attiecas uz commit SHA: tas piesaista bloku sarakstu, bet faili tiek iegūti no atsauces, ko norāda šī commit baseUrl.
GitHub Pages
Ja vēlaties tīrāku URL, reģistru varat arī nodrošināt, izmantojot GitHub Pages:
- Iespējojiet repozitorijam GitHub Pages
- Iestatiet
baseUrluz savu Pages URL:https://acme.github.io/acme-blocks/blocks registry.jsonir pieejams vietnēhttps://acme.github.io/acme-blocks/registry.json
Privātie repozitoriji
Privātiem repozitorijiem izmantojiet objektu reģistra formātu ar GitHub personīgo piekļuves pilnvaru:
{
"registries": {
"private": {
"url": "https://raw.githubusercontent.com/acme/private-blocks/main/registry.json",
"headers": {
"Authorization": "Bearer ${GITHUB_TOKEN}"
}
}
}
}
Iestatiet pilnvaru savā vidē:
export GITHUB_TOKEN=ghp_abc123
npx blockstudio add private/hero
Lai piekļūtu privāta repozitorija saturam, izmantojot raw.githubusercontent.com, pilnvarai nepieciešama repo tvēruma atļauja (vai contents:read detalizētas piekļuves pilnvarām).