GitHub
GitHub, bir kayıt defterini barındırmanın en basit yoludur. Bloklarınızı bir depoya gönderin ve GitHub’nin ham içerik URL’lerini kullanın.
Kurulum
Bu yapıda bir depo oluşturun:
acme-blocks/
registry.json
blocks/
hero/
block.json
index.php
card/
block.json
index.php
style.scss
registry.json
blocks/ dizininiz için URL ham GitHub olarak baseUrl‘ı ayarlayın:
{
"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, raw.githubusercontent.com kullanır; böylece CLI, GitHub HTML sayfası yerine ham dosya içeriğini alır.
Tüketici yapılandırması
Kullanıcılar kayıt defterinizi blocks.json dosyalarına ekler:
{
"directory": "blockstudio",
"registries": {
"acme": "https://raw.githubusercontent.com/acme/acme-blocks/main/registry.json"
}
}
Ardından:
npx blockstudio add acme/hero
Bir sürüme sabitleme
Belirli bir sürüme sabitlemek için main yerine bir etiket veya commit SHA kullanın:
{
"registries": {
"acme": "https://raw.githubusercontent.com/acme/acme-blocks/v1.0.0/registry.json"
}
}
Etiketteki registry.json de baseUrl içinde aynı etiketi kullandığı sürece bu, mevcut projelerin bozulma değişikliklerinden etkilenmesini önler. CLI, blok dosyalarını baseUrl‘ten indirir. Bu nedenle, baseUrl‘i hâlâ main‘i gösteren etiketli bir registry.json, dosyaları main‘ten yükler. Aynısı commit SHA için de geçerlidir: blok listesini sabitlerken dosyalar, bu commit’in baseUrl‘inin belirttiği ref’ten gelir.
GitHub Pages
Daha temiz bir URL tercih ederseniz kayıt defterini GitHub Pages üzerinden de sunabilirsiniz:
- Depo için GitHub Pages özelliğini etkinleştirin
baseUrldeğerini Pages URL’niz olarak ayarlayın:https://acme.github.io/acme-blocks/blocksregistry.jsonadresinden erişilebilir olur:https://acme.github.io/acme-blocks/registry.json
Özel depolar
Özel depolar için GitHub kişisel erişim belirteciyle nesne kayıt defteri biçimini kullanın:
{
"registries": {
"private": {
"url": "https://raw.githubusercontent.com/acme/private-blocks/main/registry.json",
"headers": {
"Authorization": "Bearer ${GITHUB_TOKEN}"
}
}
}
}
Belirteci ortamınızda ayarlayın:
export GITHUB_TOKEN=ghp_abc123
npx blockstudio add private/hero
raw.githubusercontent.com üzerinden özel depo içeriğine erişmek için belirtecin repo kapsamına (ince ayarlı belirteçlerde contents:read kapsamına) ihtiyacı vardır.