npm package를 GitHub packages로 배포하기
Post

npm package를 GitHub packages로 배포하기

01/11/2022 01/11/2022
1

기본 npm package 저장소은 public은 무료지만 private 은 유료이다.
하지만 github package를 이용하면 private을 500MB까지는 무료로 사용할 수 있다.

GitHub Packages

사전 준비

  1. github에 프로젝트 repository를 등록한다.

  2. github에서 private access token을 생성한다.
    package를 배포할 것이므로 write:package 권한을 주고 생성한다.

  3. github 인증을 한다.
    비밀번호는 앞서 만든 token 값을 입력한다.
    1
2
3
4

    npm login --scope=@OWNER --registry=https://npm.pkg.github.com
> Username: USERNAME
> Password: TOKEN
> Email: EMAIL-ADDRESS

npm package 배포

  1. 배포할 npm package의 package.json 파일을 수정한다.
    • name 에 @뒤에 들어가는 이름은 github 계정명을 기입한다. (@계정명/프로젝트명)
    • publishConfig 영역을 추가해준다.
      1
2
3
4
5
6
7
8
9
10

      {
   "author": "niceharu",
   "name": "@niceharu/tc",
   "version": "0.1.0",
   "module": "dist/TC.js",
   "main": "dist/TC.js",
   "publishConfig": {
       "registry":"https://npm.pkg.github.com"
   }
}
  2. 배포하기
    1

    npm publish

    성공적으로 배포가 되면 우측 하단에 배포된 Package 가 보인다.

npm package 사용

  1. github에서 읽기 권한 private access token을 생성한다.

  2. 프로젝트 루트 디렉토리에 .npmrc 파일 생성 후 아래 내용을 추가한다.
    1
2

    //npm.pkg.github.com/:_authToken=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
@niceharu:registry=https://npm.pkg.github.com/
  3. package 설치
    1

    npm install @niceharu/tc
npm
npm github package