使用 npm 注册表

对 GitHub Packages 进行身份验证

GitHub Packages 仅支持使用个人访问令牌（经典）进行身份验证。有关更多信息，请参阅“管理您的个人访问令牌”。

您需要访问令牌才能发布、安装和删除私有、内部和公共包。

您可以使用个人访问令牌（经典）对 GitHub Packages 或 GitHub API 进行身份验证。创建个人访问令牌（经典）时，您可以根据需要为令牌分配不同的范围。有关个人访问令牌（经典）的与包相关的范围的更多信息，请参阅“关于 GitHub Packages 的权限”。

要在 GitHub Actions 工作流中对 GitHub Packages 注册表进行身份验证，您可以使用

GITHUB_TOKEN 发布与工作流仓库关联的包。
需要使用至少具有 `read:packages` 范围的个人访问令牌（经典版）来安装与其他私有仓库关联的包（`GITHUB_TOKEN` 无法访问）。

在 GitHub Actions 工作流程中进行身份验证

此注册表支持细粒度权限。对于支持细粒度权限的注册表，如果您的 GitHub Actions 工作流程使用个人访问令牌来对注册表进行身份验证，我们强烈建议您更新工作流程以使用 `GITHUB_TOKEN`。有关更新使用个人访问令牌对注册表进行身份验证的工作流程的指南，请参阅 "使用 GitHub Actions 发布和安装包"。

注意：GitHub Actions 工作流程使用 REST API 删除和恢复包的功能目前处于公开测试阶段，可能会发生变化。

如果您使用 `GITHUB_TOKEN` 在 GitHub Actions 工作流程中使用 REST API 删除或恢复包，则令牌必须对该包具有 `admin` 权限。使用工作流程发布包的仓库以及您已明确连接到包的仓库会自动获得对仓库中包的 `admin` 权限。

有关 `GITHUB_TOKEN` 的更多信息，请参阅 "自动令牌身份验证"。有关在操作中使用注册表的最佳实践的更多信息，请参阅 "GitHub Actions 安全加固"。

您还可以选择独立地为 GitHub Codespaces 和 GitHub Actions 授予对包的访问权限。有关更多信息，请参阅 "配置包的访问控制和可见性" 和 "配置包的访问控制和可见性"。

使用个人访问令牌进行身份验证

您必须使用具有适当范围的个人访问令牌（经典版）才能在 GitHub Packages 中发布和安装包。有关更多信息，请参阅 "GitHub Packages 简介"。

您可以通过编辑您的个人用户 ~/.npmrc 文件以包含您的个人访问令牌（经典版），或通过在命令行中使用您的用户名和个人访问令牌登录 npm，来对 GitHub Packages 进行身份验证。

要通过将您的个人访问令牌（经典）添加到您的~/.npmrc文件中进行身份验证，请编辑项目~/.npmrc文件以包含以下行，将TOKEN替换为您的个人访问令牌。如果不存在，请创建一个新的~/.npmrc文件。

//npm.pkg.github.com/:_authToken=TOKEN

要通过登录 npm 进行身份验证，请使用npm login命令，将USERNAME替换为您的 GitHub 用户名，TOKEN替换为您的个人访问令牌（经典），并将PUBLIC-EMAIL-ADDRESS替换为您的电子邮件地址。

如果您使用的是 npm CLI 版本 9 或更高版本，并且正在使用命令行登录或注销私有注册表，则应使用--auth-type=legacy选项从提示中读取您的身份验证详细信息，而不是使用默认的浏览器登录流程。有关更多信息，请参阅npm-login。

如果 GitHub Packages 不是您使用 npm 的默认包注册表，并且您想使用npm audit命令，我们建议您在身份验证到 GitHub Packages 时使用--scope标志以及托管包的命名空间（包所处的个人帐户或组织）。

$ npm login --scope=@NAMESPACE --auth-type=legacy --registry=https://npm.pkg.github.com

> Username: USERNAME
> Password: TOKEN

发布包

注意

包名称和范围只能使用小写字母。
npm 版本的 tarball 大小必须小于 256MB。

GitHub Packages 注册表将 npm 包存储在您的组织或个人帐户中，并允许您将包与存储库关联。您可以选择从存储库继承权限，或独立于存储库设置粒度权限。

首次发布包时，默认可见性为私有。要更改可见性或设置访问权限，请参阅“配置包的访问控制和可见性”。有关将已发布的包与存储库链接的更多信息，请参阅“将存储库连接到包”。

您可以在发布包后立即将包连接到存储库，方法是在package.json文件中包含repository字段。您也可以使用此方法将多个包连接到同一个存储库。有关更多信息，请参阅“将多个包发布到同一个存储库”。

注意：如果您发布与存储库链接的包，则该包会自动继承链接存储库的访问权限，并且链接存储库中的 GitHub Actions 工作流程会自动获得对该包的访问权限，除非您的组织禁用了自动继承访问权限。有关更多信息，请参阅“配置包的访问控制和可见性”。

您可以使用项目中的本地 .npmrc 文件或 package.json 中的 publishConfig 选项来设置项目的范围映射。GitHub Packages 仅支持作用域 npm 包。作用域包的名称格式为 @NAMESPACE/PACKAGE-NAME。作用域包始终以 @ 符号开头。您可能需要更新 package.json 中的名称以使用作用域名称。例如，如果您是用户 octocat 并且您的包名为 test，则应将作用域包名称分配如下："name": "@octocat/test"。

发布包后，您可以在 GitHub 上查看该包。有关更多信息，请参阅“查看包”。

使用本地 .npmrc 文件发布包

您可以使用 .npmrc 文件来配置项目的范围映射。在 .npmrc 文件中，使用 GitHub Packages URL 和帐户所有者，以便 GitHub Packages 知道将包请求路由到哪里。使用 .npmrc 文件可以防止其他开发人员意外地将包发布到 npmjs.org 而不是 GitHub Packages。

验证到 GitHub Packages。有关更多信息，请参阅“验证到 GitHub Packages”。
在与您的 package.json 文件相同的目录中，创建或编辑 .npmrc 文件以包含一行，指定 GitHub Packages URL 和托管包的命名空间。将 NAMESPACE 替换为包将被作用域到的用户或组织帐户的名称。
```
@NAMESPACE:registry=https://npm.pkg.github.com
```
将 .npmrc 文件添加到 GitHub Packages 可以找到您的项目的存储库中。有关更多信息，请参阅“将文件添加到存储库”。
验证项目 package.json 中的包名称。name 字段必须包含包的作用域和名称。例如，如果您的包名为“test”，并且您将其发布到“My-org” GitHub 组织，则 package.json 中的 name 字段应为 @my-org/test。
验证项目 package.json 中的 repository 字段。repository 字段必须与您的 GitHub 存储库的 URL 相匹配。例如，如果您的存储库 URL 为 github.com/my-org/test，则 repository 字段应为 https://github.com/my-org/test.git。
发布包
```
npm publish
```

使用 `package.json` 文件中的 `publishConfig` 发布包

您可以使用 package.json 文件中的 publishConfig 元素来指定要发布包的注册表。有关更多信息，请参阅 npm 文档中的“publishConfig”。

编辑您的包的package.json文件，并包含一个publishConfig条目。
```
"publishConfig": {
  "registry": "https://npm.pkg.github.com"
},
```
验证项目 package.json 中的 repository 字段。repository 字段必须与您的 GitHub 存储库的 URL 相匹配。例如，如果您的存储库 URL 为 github.com/my-org/test，则 repository 字段应为 https://github.com/my-org/test.git。
发布包
```
npm publish
```

将多个包发布到同一个仓库

要发布多个包并将它们链接到同一个仓库，您可以在每个包的package.json文件的repository字段中包含 GitHub 仓库的 URL。有关更多信息，请参阅 npm 文档中的“创建 package.json 文件”和“创建 Node.js 模块”。

为了确保仓库的 URL 正确，请将REPOSITORY替换为包含您要发布的包的仓库的名称，并将OWNER替换为 GitHub 上拥有该仓库的个人帐户或组织的名称。

GitHub Packages 将根据 URL 匹配仓库。

"repository":"https://github.com/OWNER/REPOSITORY",

安装包

您可以通过将包作为依赖项添加到项目的package.json文件中，从 GitHub Packages 安装包。有关在项目中使用package.json的更多信息，请参阅 npm 文档中的“使用 package.json”。

默认情况下，您可以从一个组织添加包。有关更多信息，请参阅“从其他组织安装包”。

您还需要将.npmrc文件添加到您的项目中，以便所有安装包的请求都将通过 GitHub Packages。当您通过 GitHub Packages 路由所有包请求时，您可以使用来自npmjs.org的范围包和非范围包。有关更多信息，请参阅 npm 文档中的“npm-scope”。

验证到 GitHub Packages。有关更多信息，请参阅“验证到 GitHub Packages”。
在与您的 package.json 文件相同的目录中，创建或编辑 .npmrc 文件以包含一行，指定 GitHub Packages URL 和托管包的命名空间。将 NAMESPACE 替换为包将被作用域到的用户或组织帐户的名称。
```
@NAMESPACE:registry=https://npm.pkg.github.com
```
将 .npmrc 文件添加到 GitHub Packages 可以找到您的项目的存储库中。有关更多信息，请参阅“将文件添加到存储库”。
配置项目中的package.json以使用您要安装的包。要将您的包依赖项添加到 GitHub Packages 的package.json文件中，请指定完整的范围包名称，例如@my-org/server。对于来自npmjs.com的包，请指定完整名称，例如@babel/core或lodash。将ORGANIZATION_NAME/PACKAGE_NAME替换为您的包依赖项。
```
{
  "name": "@my-org/server",
  "version": "1.0.0",
  "description": "Server app that uses the ORGANIZATION_NAME/PACKAGE_NAME package",
  "main": "index.js",
  "author": "",
  "license": "MIT",
  "dependencies": {
    "ORGANIZATION_NAME/PACKAGE_NAME": "1.0.0"
  }
}
```
安装包。
```
npm install
```

从其他组织安装包

默认情况下，您只能使用来自一个组织的 GitHub Packages 包。如果您想将包请求路由到多个组织和用户，您可以在.npmrc文件中添加额外的行，将NAMESPACE替换为包范围的个人帐户或组织的名称。

@NAMESPACE:registry=https://npm.pkg.github.com
@NAMESPACE:registry=https://npm.pkg.github.com

谁可以使用此功能？

本文内容