이 블로그 포스트에서는 NPM(Node Package Manager)을 사용하여 패키지를 배포하는 개발자들을 위한 꿀팁을 소개하겠습니다. 특히, GitHub 저장소의 주요 단축키를 NPM 패키지에 추가하는 방법에 대해 알아보겠습니다.

단축키란?

단축키는 프로젝트의 버전 관리를 편리하게 해주는데, 특히 GitHub에서 이슈를 만들거나 코멘트를 달거나 풀 리퀘스트를 보내는 등의 작업을 더 편리하게 할 수 있습니다. 예를 들어, 이슈를 생성할 때 매번 GitHub 웹사이트에 들어가지 않아도 되고, 순식간에 풀 리퀘스트를 보낼 수 있게 해줍니다.

단축키를 패키지에 추가하기

먼저, 패키지의 루트 디렉토리에 .npmrc 파일을 생성합니다. 그리고 아래와 같은 내용을 추가합니다.

//npm.pkg.github.com/:_authToken=GITHUB_AUTH_TOKEN
//npm.pkg.github.com/:always-auth=true

GITHUB_AUTH_TOKEN은 GitHub에서 발급받은 personal access token입니다.

이제, 패키지의 package.json 파일에 아래와 같이 git 속성을 추가합니다.

{
  "name": "your-package-name",
  "version": "1.0.0",
  "publishConfig": {
    "registry": "https://npm.pkg.github.com/"
  },
  "git": "git+https://github.com/your-username/your-repo.git"
}

your-package-name, your-username, your-repo는 각자의 프로젝트에 맞게 변경해야 합니다.

단축키 사용하기

이제 패키지를 배포할 때, 터미널에 아래와 같이 입력하면 GitHub 단축키를 사용하여 배포할 수 있습니다.

npm publish

결론

이렇게하면 간단한 설정만으로도 NPM 패키지의 GitHub 단축키를 추가할 수 있습니다. 이를 통해 간편하게 프로젝트를 관리하고 GitHub을 통해 보다 효율적으로 협업할 수 있습니다.