docs: standardize Git submodule and workspace installation
Deploy Storybook / deploy (push) Successful in 1m12s
Deploy Storybook / deploy (push) Successful in 1m12s
This commit is contained in:
1 parent
3a4c63b5a4
commit
89011a2e42
18 files changed
+51
-39
No files matched your search
@@ -32,7 +32,7 @@ Storybook은 기존 HM Component·Pattern·Theme·Variant·State·Interaction을
|
||||
|
||||
현재 한맥그린·브라운·오렌지는 각 8단계가 완료됐습니다. Orange는 Light 4 `#FEBA88` → Light 3 `#EC8F53` → Light 2 `#F87725` → Light 1 `#EB5F00` → Default `#CC5200` → Dark 1 `#BC4C00` → Dark 2 `#883700` → Dark 3 `#4F2000`입니다. [최신 확정 Palette](docs/guidelines/brand-color-steps.md), [Orange 확정 기록](docs/reports/orange-final-confirmation-2026-10-11.md), [Runtime 계약](docs/guidelines/runtime-theme-contract.md)을 따릅니다. [v2 선택 검증 보고](docs/reports/v2-publisher-review-2026-10-11.md)의 Dark 1/2 보류는 당시 기록입니다.
|
||||
|
||||
공식 소스 저장소는 [Gitea HMDesign](https://gitea.hmac.kr/b25027/HMDesign)입니다. 이전 원본은 [GitHub HMDesignSystemTest](https://github.com/shkim25027/HMDesignSystemTest)의 `90583ab6046ab5dc1ac35d94d38f3301c9a4dfe1`이며, GitHub 이력을 병합하지 않고 공식 Gitea의 기존 이력 위에 소스 반영을 완료했습니다. 먼저 [AGENTS.md](AGENTS.md)를 읽고 기존 Component → Variant/Prop → Composition 순서로 재사용합니다.
|
||||
공식 소스 저장소는 [Gitea HMDesign](https://gitea.hmac.kr/shkim4/HMDesign)입니다. 이전 소유자 주소 `https://gitea.hmac.kr/b25027/HMDesign`은 현재 주소로 리다이렉트되지만 새 Clone·Submodule에는 현재 주소를 사용합니다. 이전 원본은 [GitHub HMDesignSystemTest](https://github.com/shkim25027/HMDesignSystemTest)의 `90583ab6046ab5dc1ac35d94d38f3301c9a4dfe1`이며, GitHub 이력을 병합하지 않고 공식 Gitea의 기존 이력 위에 소스 반영을 완료했습니다. 먼저 [AGENTS.md](AGENTS.md)를 읽고 기존 Component → Variant/Prop → Composition 순서로 재사용합니다.
|
||||
|
||||
현재 검증 범위와 남은 제한은 [2026-10-10 잔여 이슈 회귀 보고](docs/guidelines/publisher-validation-2026-10-10.md)를 확인합니다.
|
||||
|
||||
@@ -42,10 +42,10 @@ Storybook은 기존 HM Component·Pattern·Theme·Variant·State·Interaction을
|
||||
|
||||
최신 [Generic Status Error](docs/reports/generic-status-error-token-2026-10-11.md)는 `#B3261E` / Provisional이며 기존 Destructive `#D32F2F`를 유지합니다. [Disabled Input Label](docs/reports/disabled-input-label-2026-10-11.md)은 승인된 Input Story 소비 범위 60%, 공통 Label은 50%입니다. [Background Gradient 기록](docs/reports/brown-orange-background-gradients-2026-10-11.md)과 [현재 계약](docs/guidelines/runtime-theme-contract.md)은 Green·Brown·Orange 공통 배경을 구분하며, Foundation Color의 Button 전용 미리보기는 제거하고 실제 Button·Dashboard Gradient는 유지합니다. Focus `#266651`은 시험 적용 상태입니다.
|
||||
|
||||
Node.js는 lockfile의 `^20.19.0 || >=22.12.0` 조건을 충족해야 합니다(Node 21 제외). 검증 기록은 **Node 20.20.1 / npm 10.8.2**(2026-10-11)와 **Node 22.23.2 / npm 10.9.8**(2026-10-20, SW 포함 전체 build·Storybook build)입니다. Docker 이미지는 `node:24-alpine`에서 빌드하며 Docker 경로는 아직 실제 빌드로 검증하지 않았습니다. Node 설치 시 제공되는 npm과 PATH를 확인하고, 재현 시에는 검증한 버전을 사용합니다. 최초 설치에는 공식 Gitea와 npm 레지스트리 접근이 필요합니다.
|
||||
Node.js는 lockfile의 `^20.19.0 || >=22.12.0` 조건을 충족해야 합니다(Node 21 제외). 검증 기록은 **Node 20.20.1 / npm 10.8.2**(2026-10-11)와 **Node 22.23.2 / npm 10.9.8**(2026-10-20, SW 포함 전체 build·Storybook build)입니다. Docker 이미지는 `node:24-alpine`에서 빌드하며 Docker 경로는 아직 실제 빌드로 검증하지 않았습니다. Node 설치 시 제공되는 npm과 PATH를 확인하고, 재현 시에는 검증한 버전을 사용합니다. 최초 설치에는 공식 Gitea와 외부 dependency용 공개 npm 레지스트리(`registry.npmjs.org`) 접근이 필요합니다. HM 패키지용 Gitea npm Registry나 `.npmrc` 설정은 필요하지 않습니다.
|
||||
|
||||
```powershell
|
||||
git clone https://gitea.hmac.kr/b25027/HMDesign.git
|
||||
git clone https://gitea.hmac.kr/shkim4/HMDesign.git
|
||||
cd HMDesign
|
||||
node --version
|
||||
npm --version
|
||||
@@ -128,7 +128,7 @@ SW는 Tailwind 없이 앱 진입점에서 `import "@hm-design/sw/styles.css"`를
|
||||
|
||||
화면 생성 Reference: [Navigation 선택 근거](docs/guidelines/navigation-single-mode.md#선택-근거), [GNB Desktop·Mobile 구성](docs/patterns/gnb.md#8-desktop--mobile)과 [내부 Sidebar](docs/patterns/gnb.md#15-gnb-only-sidebar-composition-2026-10-08), [FilterBar 조회·초기화 소비 예제](docs/patterns/filter-bar.md#61-조회-버튼으로-적용하는-소비-예제). 일반 업무 목록의 모드를 임의 확정하거나 FilterBar에 조회 API가 있다고 가정하지 않습니다.
|
||||
|
||||
루트 `package.json`의 `workspaces`(`packages/*`)로 연결됩니다. 확인: `npm run typecheck`, `npm run build`. 위 [패키지 구성](#패키지-구성)의 5개 패키지는 모두 private이 아니며 ESM JS·타입 선언·CSS를 `dist`에서 export합니다. `npm run build:packages`로 재빌드할 수 있고, Registry publish 이력은 Git 기반 테스트 공유의 검증 범위에 포함하지 않습니다.
|
||||
루트 `package.json`의 `workspaces`(`packages/*`)로 연결됩니다. 확인: `npm run typecheck`, `npm run build`. 위 [패키지 구성](#패키지-구성)의 5개 패키지는 모두 private이 아니며 ESM JS·타입 선언·CSS를 `dist`에서 export합니다. `npm run build:packages`로 재빌드할 수 있습니다. HM 패키지는 npm Registry로 배포하지 않으며, 다른 프로젝트는 [외부 프로젝트 설치](docs/guidelines/external-install-submodule.md)의 Git Submodule + npm Workspace 방식으로 연결합니다.
|
||||
|
||||
## 파일 위치
|
||||
|
||||
@@ -185,8 +185,12 @@ Component Mapping은 Semantic/Theme palette를 참조하며 기본 API로 HM 스
|
||||
- 외부 프로젝트 설치: [Git Submodule + npm Workspace](docs/guidelines/external-install-submodule.md)
|
||||
- 프로젝트·서비스 적용: [프로젝트 지침](docs/guidelines/프로젝트-지침.md), [개발 적용](docs/guidelines/개발-적용-가이드.md)
|
||||
|
||||
## Package Registry / Publish (별도 내부 운영 정보)
|
||||
## 패키지 배포 방식 (Git Submodule + npm Workspace)
|
||||
|
||||
패키지 build와 Registry publish는 별도 단계입니다. Registry 설치·publish·실제 CDN 운영은 Git 기반 테스트 공유의 실행 조건이나 검증 범위가 아닙니다. 서비스 배포·버전·캐시·롤백 계획은 [운영/배포 가이드](docs/guidelines/운영-배포-가이드.md)를 따릅니다.
|
||||
HM 패키지는 npm Registry로 배포하지 않습니다. 다른 React 프로젝트는 이 저장소를 Git Submodule로 고정하고, HMDesign 안에서 `npm ci`·`npm run build:packages`를 실행한 뒤 소비 프로젝트의 npm Workspace로 연결합니다. 절차는 [외부 프로젝트 설치](docs/guidelines/external-install-submodule.md)를 따르며 버전 식별은 Submodule Commit SHA입니다.
|
||||
|
||||
- `package.json`의 `version`은 Workspace 연결과 peer 범위에 쓰는 값이며 Registry 배포 버전이 아닙니다.
|
||||
- 2026-10-07 Gitea npm Registry에 시험 게시한 `@hm-design/ui@0.1.0`·`@hm-design/center-graphic@0.1.0`은 현재 소스와 다른 이전 산출물이므로 설치에 사용하지 않습니다. 소비 프로젝트의 `.npmrc`에 `@hm-design:registry`를 추가하지 않습니다.
|
||||
- Theme CDN 등 서비스 배포·버전·캐시·롤백 계획은 [운영/배포 가이드](docs/guidelines/운영-배포-가이드.md)를 따릅니다.
|
||||
|
||||
CENTER Graphic은 현재 내부 테스트/검토 목적 범위에서 제공합니다. 외부 공개 또는 사외 배포 전 별도 License 확정이 필요합니다. 임의의 오픈소스 License를 부여하지 않습니다.
|
||||
Reference in new issue
Block a user