Question

如何在"dependency"中列出私人Github仓库为package.json？我尝试了ryanve/example这样的npm's Github URLs语法，但在包文件夹中执行npm install会导致无法安装＆＃34;私有依赖项的错误。是否有一种特殊的语法（或其他一些机制）来依赖私人回购？

Answer 1

可以通过https and oauth 或 ssh。

完成

https和oauth： create an access token具有“repo”范围和then use this syntax：

"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"

（注意在用户之前使用冒号而不是斜杠）

Answer 2

如果有人正在为Git Lab寻找另一个选项并且上面的选项不起作用，那么我们还有另一种选择。对于Git Lab服务器的本地安装，我们发现下面的方法允许我们包含包依赖。我们生成并使用访问令牌来执行此操作。

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

当然，如果一个人以这种方式使用访问密钥，它应该具有一组有限的权限。

祝你好运！

Answer 3

使用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

在选择范围部分中，选中 repo ：完全控制私有存储库

这样，令牌可以访问用户可以看到的私人回购

现在，在您的组织中创建新组，将此用户添加到组中，并仅添加您期望的存储库以这种方式拉（只读权限！）

您需要确保将此配置仅推送到私人仓库

然后你可以将它添加到/ packages.json（bot-user是用户名，xxxxxxxxx是生成的个人令牌）

// 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

Answer 4

NPM 没有 repo 中的访问令牌

此方法要求使用包的任何人使用他们自己的个人访问令牌而不是单个组令牌进行身份验证，这允许存储库没有访问令牌。您也无需在每次不再授予用户访问权限时都创建新的访问令牌，相反，从 GitHub 中的存储库中删除用户将自动删除其包访问权限。

这是 GitHub 的 NPM 指南的精简版： https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry

将您的 GitHub 存储库发布为 NPM 包

在开发者设置中创建个人访问令牌：https://github.com/settings/tokens
登录 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

按照以下格式更新 package.json。

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

要发布 NPM 包，请运行：

npm publish

在项目中安装私有 NPM 包

以与上述第 2 步完全相同的方式登录 NPM。
使用 npm install @jessica/my-npm-package 安装软件包

完成！

继续阅读您的项目是否有需要安装此私有 NPM 包的 GitHub 操作脚本。

GitHub 操作：如何安装私有 NPM 包

在 CI 环境中，您还需要 npm login 进行类似的身份验证。否则，npm install 将失败，因为它无权访问私有 NPM 包。预配置的一种方法是使用 .npmrc 文件；但是，这会将身份验证凭据提交给该文件的存储库。因此，另一种方法是使用 NPM 工具 npm-cli-login。要求您使用自己的个人访问令牌（不是最佳选择：您离开存储库，CI 中断），或者专门为 CI 设置一个 GitHub 帐户并使用该帐户创建一个访问令牌。

使用仅限 CI 的 GitHub 帐户创建访问令牌或从您自己的 GitHub 帐户获取访问令牌。
在存储库设置中将该访问令牌作为“秘密”添加到您的存储库中。
更新您的 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 Actions 稍后运行 npm install 时，脚本将可以访问私有 NPM 包。

仅供参考：如果您熟悉 GitHub Actions，您可能会问为什么我们不能使用 GitHub 自动提供的 secrets.GITHUB_TOKEN？原因是secrets.GITHUB_TOKEN 只有有权访问运行 GitHub 操作的存储库，而无权访问私有 NPM 包的存储库。

Answer 5

虽然这是一个老问题，但在这里添加一个跨平台的答案。

在 node_modules 中访问私有仓库的一般 npm v7 syntax 是 -

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

您必须使用至少具有读取权限的 git 服务提供商创建访问令牌。

以下是大多数流行平台的链接：

请注意，github 会创建与您的用户名相关联的令牌，并且没有令牌名称，因此，对于 github，请使用您的用户名而不是 token_name。

Answer 6

我无法在 Docker 容器中使接受的答案起作用。

对我有用的是在文件.nextrc

中从github设置个人访问令牌。

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",

如何使用私有Github repo作为npm依赖

6 个答案:

NPM 没有 repo 中的访问令牌

将您的 GitHub 存储库发布为 NPM 包

在项目中安装私有 NPM 包

GitHub 操作：如何安装私有 NPM 包