Lewati ke konten

GitHub

GitHub adalah cara termudah untuk meng-host registri. Dorong blok Anda ke repositori dan gunakan URL konten mentah milik GitHub.

Penyiapan

Buat repositori dengan struktur berikut:

Kode
acme-blocks/
  registry.json
  blocks/
    hero/
      block.json
      index.php
    card/
      block.json
      index.php
      style.scss

registry.json

Atur baseUrl ke GitHub URL mentah untuk direktori blocks/ Anda:

JSON
{
  "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 menggunakan raw.githubusercontent.com agar CLI memperoleh konten file mentah, bukan halaman GitHub HTML.

Konfigurasi konsumen

Pengguna menambahkan registri Anda ke blocks.json mereka:

JSON
{
  "directory": "blockstudio",
  "registries": {
    "acme": "https://raw.githubusercontent.com/acme/acme-blocks/main/registry.json"
  }
}

Lalu:

Shell
npx blockstudio add acme/hero

Menetapkan versi rilis

Untuk menetapkan versi tertentu, gunakan tag atau SHA commit sebagai pengganti main:

JSON
{
  "registries": {
    "acme": "https://raw.githubusercontent.com/acme/acme-blocks/v1.0.0/registry.json"
  }
}

Ini mencegah perubahan yang merusak memengaruhi proyek yang sudah ada, selama registry.json pada tag tersebut juga menggunakan tag di baseUrl-nya. CLI mengunduh file blok dari baseUrl, sehingga registry.json bertag yang baseUrl-nya masih menunjuk ke main akan memasang file dari main. Hal yang sama berlaku untuk SHA commit: SHA tersebut menetapkan daftar blok, sedangkan file diambil dari ref yang disebutkan oleh baseUrl commit itu.

GitHub Pages

Anda juga dapat menyajikan registri melalui GitHub Pages jika menginginkan URL yang lebih rapi:

  1. Aktifkan GitHub Pages untuk repositori
  2. Atur baseUrl ke URL Pages Anda: https://acme.github.io/acme-blocks/blocks
  3. registry.json dapat diakses di https://acme.github.io/acme-blocks/registry.json

Repositori privat

Untuk repositori privat, gunakan format registri objek dengan token akses pribadi GitHub:

JSON
{
  "registries": {
    "private": {
      "url": "https://raw.githubusercontent.com/acme/private-blocks/main/registry.json",
      "headers": {
        "Authorization": "Bearer ${GITHUB_TOKEN}"
      }
    }
  }
}

Atur token di lingkungan Anda:

Shell
export GITHUB_TOKEN=ghp_abc123
npx blockstudio add private/hero

Token memerlukan cakupan repo (atau contents:read untuk token berbutir halus) guna mengakses konten repositori privat melalui raw.githubusercontent.com.