Skip to content

feat: README 영문 기본(en/ko/ja) + npm 릴리즈 체계 (v1.0.0) - #30

Merged
serithemage merged 3 commits into
mainfrom
feat/i18n-npm-release
Aug 24, 2026
Merged

serithemage merged 3 commits into
mainfrom
feat/i18n-npm-release

Conversation

@serithemage

Copy link
Copy Markdown
Contributor

개요

사용자 요청: README를 영어 기본으로 전환(한국어·일본어 추가 제공)하고 GitHub에서 npm으로 릴리즈 가능하게.

변경

  • README.md 영어 전면 재작성(기본), README.ko.md(한국어 이관)·README.ja.md(일본어 신규) — 상단 언어 전환 링크, 3파일 헤딩 구조·수치·명령 완전 일치 검증
  • LICENSE: MIT (사용자 확정)
  • package.json: private 제거, v1.0.0, 메타데이터(description/keywords/repository/homepage/bugs), files 화이트리스트, prepublishOnly=test+build. aws-cdk·ts-node·typescript를 dependencies로 이동 — tkf가 패키지 루트 cwd에서 npx cdk/ts-node를 실행하므로 npm i -g token-forge 한 번으로 동작(R1 간편함 우선)
  • .github/workflows/: ci.yml(main push·PR 테스트), release.yml(v* 태그 → npm publish --provenance, NPM_TOKEN은 publish 스텝에만 스코프)
  • README 설치 안내를 npm 전역 설치 우선으로 (사전 조건의 별도 aws-cdk 설치 요구 제거)

검증

  • 테스트 145개·빌드 통과, npm pack 실측(41파일 — test/docs/cdk.out 미포함, LICENSE·README 자동 포함 확인)
  • 내부 리뷰 clean (CodeSolar 봇 장애 중 — 번역 수치 3개 언어 교차 대조, 워크플로 시크릿 스코프·최소 권한, 의존성 이동 타당성 코드 추적 완료)

릴리즈 절차 (머지 후, #28)

  1. [사용자] npm 토큰 발급 → 리포 시크릿 NPM_TOKEN 등록
  2. git tag v1.0.0 && git push origin v1.0.0

🤖 Generated with Claude Code

serithemage and others added 3 commits August 24, 2026 11:22
영어를 기본 언어로 삼고 한국어(README.ko.md)·일본어(README.ja.md)를
별도 파일로 제공. 각 파일 상단에 언어 전환 링크를 추가했다.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- LICENSE: MIT, Copyright (c) 2026 roboco-io
- package.json: private 제거, version 1.0.0, description/keywords/
  repository/homepage/bugs/author 채움, prepublishOnly에 test+build 연결
- aws-cdk/ts-node/typescript를 devDependencies에서 dependencies로 이동:
  tkf up이 실행 시점에 npx ts-node/npx cdk를 패키지 루트 cwd에서 호출하므로
  (cli/program.ts execInherit, cdk.json app) 설치 사용자가 별도로 이 셋을
  준비하지 않아도 동작하게 하기 위함 — 설치 크기보다 "npm i -g token-forge
  한 번으로 동작"하는 R1 간편함을 우선
- files 화이트리스트로 배포 범위 통제(ts 소스 포함 — ts-node로 직접 실행)
- .github/workflows/ci.yml: main push/PR에서 test+build
- .github/workflows/release.yml: v* 태그 push 시 test+build 후
  npm publish --provenance (NPM_TOKEN, id-token: write)
package.json이 npm 릴리즈 체계로 정비되며(token-forge v1.0.0) aws-cdk가
dependencies에 포함됐다. tkf CLI 절의 설치 명령을 npm install -g token-forge
우선으로 바꾸고 소스 설치는 대안 한 줄로 남겼다. 사전 조건 절의
AWS CDK CLI 별도 설치 안내는 패키지에 포함된다는 설명으로 완화했다
(cdk bootstrap 요구는 유지).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@serithemage
serithemage merged commit 01f54e2 into main Aug 24, 2026
1 check passed
@serithemage
serithemage deleted the feat/i18n-npm-release branch August 24, 2026 02:41

@codesolarlght codesolarlght Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔆 CodeSolar review ✅ Looks good

README i18n (en/ko/ja) + npm release setup. CI and release workflows added with minimal permissions; package.json configured for npm publish with files whitelist and prepublishOnly hook; aws-cdk/ts-node/typescript moved to dependencies for global CLI convenience; three READMEs translated consistently.

✅ No issues worth flagging.


solar-pro4 (openrouter) · 7 files · +706/-152 · 730.4s · CodeSolar

Comment /codesolar on this PR to re-run the review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant