사설 Github repo를 npm 종속성으로 사용하는 방법

사설 Github repo를 npm 종속성으로 사용하는 방법

를 인를 Github repo로 어떻게 합니까?"dependency"package.json다음과 같은 npm의 Github URL 구문을 시도했습니다.ryanve/example 하만하기를 하는 것.npm install패키지 폴더에서 개인 종속성에 대해 "설치할 수 없음" 오류가 발생합니다.개인 저장소에 의존하기 위한 특별한 구문(또는 다른 메커니즘)이 있습니까?

https 및 oauthor ssh를 통해 수행할 수 있습니다.

https 및 oauth: "repo" 범위를 가진 액세스 토큰을 만들고 다음 구문을 사용합니다.

"package-name": "git+https://<github_token>:x-oauth-basic@github.com/<user>/<repo>.git"

또는

ssh: setup ssh 다음 구문을 사용합니다.

"package-name": "git+ssh://git@github.com:<user>/<repo>.git"

(사용자 앞에 슬래시 대신 콜론을 사용합니다.)

repo에 액세스 토큰이 없는 NPM

이 방법을 사용하려면 패키지를 사용하는 모든 사용자가 단일 그룹 토큰이 아닌 자신의 개인 액세스 토큰으로 인증해야 하며, 이를 통해 레포에 액세스 토큰이 필요하지 않습니다.또한 사용자에게 더 이상 액세스 권한을 부여하지 않아야 할 때마다 새 액세스 토큰을 만들 필요가 없으며, 대신 GitHub에서 사용자를 제거하면 패키지 액세스가 자동으로 제거됩니다.

다음은 GitHub의 NPM 가이드의 요약 버전입니다. https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry

---

GitHub Repo를 NPM 패키지로 게시

1. 개발자 설정에서 개인 액세스 토큰을 만듭니다. https://github.com/settings/tokens
2. NPM에 로그인

npm login --scope=@<USERNAME of repo owner in lowercase> --registry=https://npm.pkg.github.com

Username: <Your personal GitHub username>
Password: <Create a GitHub Access Token with your account and paste it here>
Email: <Email associated with the same account>

예: 사용자 @Bobby가 github.com/Jessica/my-npm-package 을 NPM 패키지로 게시하려는 경우

npm login --scope=@jessica --registry=https://npm.pkg.github.com

Username: bobby
Password: yiueytiupoasdkjalgheoutpweoiru
Email: bobby@example.com

3. package.json아래 형식을 따릅니다.

  "name": "@jessica/my-npm-package",
  "repository": "git://github.com/jessica/my-npm-package.git",
  "publishConfig": {
    "registry":"https://npm.pkg.github.com"
  },

4. NPM 패키지를 게시하려면 다음을 실행합니다.

npm publish

---

프로젝트에 개인 NPM 패키지 설치

1. 위의 2단계와 동일한 방법으로 NPM에 로그인합니다.
2. 를 패지를설다와 함께 합니다.npm install @jessica/my-npm-package

알았어!

프로젝트에 이 개인 NPM 패키지를 설치해야 하는 GitHub Actions 스크립트가 있는지 계속 읽어보십시오.

---

GitHub 작업:개인 NPM 패키지 설치 방법

CI 환경에서는 다음과 같은 요구 사항도 충족해야 합니다.npm login마찬가지로 인증합니다.않으면, 않면으지그.npm install개인 NPM 패키지에 액세스할 수 없기 때문에 실패합니다.에 구성하는 한 방법은 이사구한가방을 입니다..npmrc파일. 그러나 이는 해당 파일이 있는 repo에 인증 자격 증명을 커밋됩니다.따라서 다른 방법은 NPM 도구 npm-cli-login을 사용하는 것입니다.개인 액세스 토큰을 사용하거나(최적이 아님: repo를 탈퇴하거나, CI 중단) CI 전용 GitHub 계정을 설정하고 해당 계정으로 액세스 토큰을 생성해야 합니다.

1. CI 전용 GitHub 계정으로 액세스 토큰을 만들거나 자신의 GitHub 계정에서 액세스 토큰을 가져옵니다.
2. 해당 액세스 토큰을 repo 설정의 "비밀"로 repo에 추가합니다.
3. GitHub Actions 워크플로우 스크립트를 업데이트하여 NPM을 설치한 후 실행하기 전에 이 단계를 실행합니다.npm install:

- name: Login to GitHub private NPM registry
  env:
    CI_ACCESS_TOKEN: ${{ secrets.NAME_OF_YOUR_ACCESS_TOKEN_SECRET }}
  shell: bash
  run: |
    npm install -g npm-cli-login
    npm-cli-login -u "USERNAME" -p "${CI_ACCESS_TOKEN}" -e "EMAIL" -r "https://npm.pkg.github.com" -s "@SCOPE"
        

교체하다NAME_OF_YOUR_ACCESS_TOKEN_SECRET,USERNAME,EMAIL그리고.SCOPE.

예를들면

- name: Login to GitHub private NPM registry
  env:
    CI_ACCESS_TOKEN: ${{ secrets.MY_TOKEN }}
  shell: bash
  run: |
    npm install -g npm-cli-login
    npm-cli-login -u "ci-github-account" -p "${CI_ACCESS_TOKEN}" -e "ci-github-account@example.com" -r "https://npm.pkg.github.com" -s "@jessica"

알았어!

GitHub 작업이 나중에 실행될 때npm install스크립트는 개인 NPM 패키지에 액세스할 수 있습니다.

참고: GitHub Actions에 익숙하다면, 왜 우리가 사용할 수 없는지 물어볼 수 있습니다.secrets.GITHUB_TOKEN어떤 GitHub가 자동으로 공급합니까?이유는secrets.GITHUB_TOKEN GitHub Actions를 실행하는 repo에만 액세스할 수 있으며 개인 NPM 패키지의 repo에는 액세스할 수 없습니다.

누군가 Git Lab에 대한 다른 옵션을 찾고 있는데 위의 옵션이 작동하지 않으면 다른 옵션이 있습니다.Git Lab 서버의 로컬 설치의 경우 아래의 접근 방식을 통해 패키지 종속성을 포함할 수 있습니다.이를 위해 액세스 토큰을 생성하고 사용합니다.

$ npm install --save-dev https://git.yourdomain.com/userOrGroup/gitLabProjectName/repository/archive.tar.gz?private_token=InsertYourAccessTokenHere

물론 이러한 방식으로 액세스 키를 사용하는 경우에는 제한된 권한 집합이 있어야 합니다.

행운을 빕니다.

git에는 https 형식이 있습니다.

https://github.com/equivalent/we_demand_serverless_ruby.git

이 형식은 사용자 + 암호를 허용합니다.

https://bot-user:xxxxxxxxxxxxxxxxxxxxxxxxxxx@github.com/equivalent/we_demand_serverless_ruby.git

그래서 당신이 할 수 있는 것은 단지 봇으로만 사용될 새로운 사용자를 만들고, 그가 단지 당신이 NPM 모듈에 로드하고 싶은 저장소를 읽을 수 있는 충분한 권한만 추가하고, 그것을 당신의 컴퓨터에 직접 가지고 있는 것입니다.packages.json

 Github > Click on Profile > Settings > Developer settings > Personal access tokens > Generate new token

범위 선택 파트에서 on repo를 확인합니다.개인 저장소에 대한 완벽한 제어

토큰이 사용자가 볼 수 있는 개인 저장소에 액세스할 수 있도록 하기 위해서입니다.

이제 조직에서 새 그룹을 만들고 이 사용자를 그룹에 추가한 다음 이 방식으로 풀링될 것으로 예상되는 리포지토리만 추가합니다(읽기 전용 권한!).

이 구성을 개인 repo에만 푸시해야 합니다.

그런 다음 /packages.json에 이를 추가할 수 있습니다(bot-user는 사용자의 이름, xxxxxxxxxxx는 생성된 개인 토큰입니다).

// packages.json


{
  // ....
    "name_of_my_lib": "https://bot-user:xxxxxxxxxxxxxxxxxxxxxxxxxxx@github.com/ghuser/name_of_my_lib.git"
  // ...
}

https://blog.eq8.eu/til/pull-git-private-repo-from-github-from-npm-modules-or-bundler.html

수락된 답변을 도커 컨테이너에서 작동시키지 못했습니다.

제게 효과가 있었던 것은 GitHub의 개인 액세스 토큰을 다음과 같은 파일로 설정한 것입니다..netrc

ARG GITHUB_READ_TOKEN
RUN echo -e "machine github.com\n  login $GITHUB_READ_TOKEN" > ~/.netrc 
RUN npm install --only=production --force \
  && npm cache clean --force
RUN rm ~/.netrc

package.json

"my-lib": "github:username/repo",

이것은 오래된 질문이지만, 여기에 여러 플랫폼에서 작동하는 답변을 추가합니다.

node_modules의 개인 저장소에 액세스하기 위한 일반적인 npm v7 구문은 -입니다.

git+https://<token_name>:<token>@<path_to_repository>.git#<commit>

적어도 읽기 권한을 가진 Git 서비스 공급자와 함께 액세스 토큰을 만들어야 합니다.

다음은 가장 널리 사용되는 플랫폼에 대한 링크입니다.

• 깃헙
• 깃랩
• 비트 버킷

github은 사용자 이름에 연결된 토큰을 생성하지 않으며 토큰 이름이 없으므로 github에 대해 token_name 대신 사용자 이름을 사용합니다.

개인 액세스 토큰을 생성한 다음 npm에 로그인할 때 암호로 사용해야 합니다.

npm login --scope=@dave --registry=https://npm.pkg.github.com
username: ${github_username}
password: ${personal_access_token}
Email: ${public_email}

2023년 4월 현재 Github repo를 사용하는 데 효과가 있는 것은 다음과 같습니다.

npm install https://oauth2:<your-fine-grained-token>@github.com/owner/repo.git

또는 분기를 지정하려는 경우:

npm install https://oauth2:<your-fine-grained-token>@github.com/owner/repo.git#master

토큰은 https://github.com/settings/tokens?type=beta 에서 만들 수 있습니다.

언급URL : https://stackoverflow.com/questions/28728665/how-to-use-private-github-repo-as-npm-dependency