본문으로 건너뛰기

GitHub

GitHub는 레지스트리를 호스팅하는 가장 간단한 방법입니다. 블록을 저장소에 푸시하고 GitHub의 원시 콘텐츠 URL을 사용하세요.

설정

다음 구조로 저장소를 만듭니다:

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

registry.json

blocks/ 디렉터리의 원시 GitHub URL를 가리키도록 baseUrl를 설정합니다:

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는 raw.githubusercontent.com를 사용하므로 CLI가 GitHub HTML 페이지가 아니라 원시 파일 콘텐츠를 가져옵니다.

소비자 설정

사용자는 blocks.json에 레지스트리를 추가합니다:

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

그런 다음:

셸
npx blockstudio add acme/hero

릴리스 버전 고정

특정 버전으로 고정하려면 main 대신 태그나 커밋 SHA를 사용합니다:

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

태그에 있는 registry.json도 baseUrl에서 해당 태그를 사용하면 기존 프로젝트에 호환성을 깨는 변경 사항이 영향을 주지 않습니다. CLI는 baseUrl에서 블록 파일을 다운로드하므로, baseUrl가 main를 계속 가리키는 태그된 registry.json는 main의 파일을 설치합니다. 커밋 SHA도 마찬가지입니다. 블록 목록은 고정하지만 파일은 해당 커밋의 baseUrl가 가리키는 참조에서 가져옵니다.

GitHub Pages

더 깔끔한 URL를 원한다면 GitHub Pages를 통해 레지스트리를 제공할 수도 있습니다:

  1. 저장소에서 GitHub Pages를 활성화합니다.
  2. baseUrl를 Pages URL로 설정합니다: https://acme.github.io/acme-blocks/blocks
  3. registry.json에 https://acme.github.io/acme-blocks/registry.json로 접근할 수 있습니다.

비공개 저장소

비공개 저장소의 경우 GitHub 개인 액세스 토큰을 사용하는 객체 레지스트리 형식을 사용합니다:

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

환경에 토큰을 설정합니다:

셸
export GITHUB_TOKEN=ghp_abc123
npx blockstudio add private/hero

raw.githubusercontent.com를 통해 비공개 저장소 콘텐츠에 액세스하려면 토큰에 repo 범위가 필요합니다(세분화된 토큰의 경우 contents:read).