Github Action으로 NPM 라이브러리 버전 관리하기

npm 라이브러리를 개발하던 도중 버전 관리에서 약간의 불편함을 느꼈다.

개발을 한 후 npm에 배포하기 위해 매번 package.json에 들어가 버전을 올려주어야 했기 때문이다.

단체로 작업하는 큰 라이브러리가 아니였기 때문에 이런 부분에는 신경을 덜 쓰고 싶었고, github action을 활용해 npm 버전을 배포할 때 자동으로 올려주게끔 하였다.

 

NPM Access Token 발급

https://www.npmjs.com/ 에 들어가 로그인한 후 프로필은 누르면 아래에서 Access Tkoens이라는 탭을 찾을 수 있다.

들어가서 Classic Token으로 만들어주자.

만약 github package로 배포한다면 npm 말고 github에서 access token을 받아주자.

 

그럼 아래처럼 Access Token을 만드는 화면이 나오고 우리는 NPM 패키지 배포를 위해 발급하는 것이므로 publish로 타입을 설정해주고 기억하기 쉽게 이름을 지어 만들어준다.

Github Repository에 NPM 토큰 등록

토큰을 만들었다면 Github 레포에 들어가서 Repository secret으로 등록해준다.

나는 `NPM_AUTH_TOKEN` 이라는 이름으로 만들었다.

 

그리고 프로젝트 루트 디렉토리에서

.github/workflows/에 publish.yml이라는 파일을 만들어 아래 내용을 넣어주자.

이럼 버저닝 및 배포 자동화가 끝났다!
이후 push를 하면

 

귀여운 옥토캣 프사를 가진 깃헙액션 봇이 버전을 올려주고 publish도 해준다!

이제 push하기 전 최신 버전을 pull/rebase만 받아준다면 버전에 대한 신경은 조금 덜 수 있을 것 같다

 

나는 간단한 프로젝트라 `npm version patch`를 통해 patch버전만 올리게끔 했지만

github action의 트리거를 이용해 태그 네임별로 publish.yml을 만들어둔다면 major, minor, patch 버전 모두 자동화 시킬 수 있을 것 같다!