使用 npm 注册表

向 GitHub Packages 验证

需要访问令牌才能发布、安装和删除包。

可使用个人访问令牌 (PAT) 向 GitHub Packages 或 GitHub API 进行身份验证。创建个人访问令牌时，可根据需要为令牌分配不同的作用域。有关 PAT 的包相关范围的详细信息，请参阅“关于 GitHub Packages 的权限”。

要在 GitHub Actions 工作流程内向 GitHub Packages 注册表验证，您可以使用：

GITHUB_TOKEN 发布与工作流存储库相关联的包。
PAT 来安装与其他专用存储库（GITHUB_TOKEN 无法访问）相关联的包。

某些 GitHub Packages 注册表支持精细权限。这意味着你可以选择允许包由用户或组织拥有，或者链接到存储库。有关支持精细权限的注册表列表，请参阅“关于 GitHub Packages 的权限”。

对于支持精细权限的注册表，如果工作流使用 personal access token 向注册表进行身份验证，则强烈建议更新工作流以使用 GITHUB_TOKEN。

有关更新使用 personal access token 对注册表进行身份验证的工作流的指南，请参阅“升级使用 personal access token 访问注册表的工作流”。

有关 GITHUB_TOKEN 的详细信息，请参阅“工作流中的身份验证”。

有关在操作中使用注册表时的最佳做法的详细信息，请参阅“GitHub Actions 的安全强化”。

还可以选择为 Codespaces 和 GitHub Actions 单独授予对包的访问权限。有关详细信息，请参阅“确保 Codespace 访问你的包和确保工作流程访问你的包”。

使用 personal access token 进行身份验证

您必须使用具有适当范围的个人访问令牌才可在 GitHub Packages 中发布和安装。有关详细信息，请参阅“关于 GitHub Packages”。

通过编辑你的每用户 ~/.npmrc 文件以包含 personal access token (classic)，或者在命令行上使用用户名和 personal access token 登录 npm，你可以使用 npm 对 GitHub Packages 进行身份验证。

若要通过将 personal access token (classic) 添加到 ~/.npmrc 文件来进行身份验证，请编辑项目的 ~/.npmrc 文件以包含以下行，将 TOKEN 替换为你的 personal access token 。创建一个新的 ~/.npmrc 文件（如果不存在）。

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

若要通过登录到 npm 进行身份验证，请使用 npm login 命令，将 USERNAME 替换为你的 GitHub 用户名，将 TOKEN 替换为你的 personal access token (classic)，并将 PUBLIC-EMAIL-ADDRESS 替换为你的电子邮件地址。

如果 GitHub Packages 不是使用 npm 的默认包注册表，并且你要使用 npm audit 命令，我们建议你在对 GitHub Packages 进行身份验证时，将 --scope 标志与包的所有者一起使用。

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

> Username: USERNAME
> Password: TOKEN
> Email: PUBLIC-EMAIL-ADDRESS

发布包

注意：包名称和作用域只能使用小写字母。

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

首次发布包时，默认可见性是私有的。将包链接到存储库时，包可见性取决于存储库的可见性。若要更改可见性或设置访问权限，请参阅“配置包的访问控制和可见性”。

默认情况下，GitHub Packages 将包发布到你在 package.json 文件的名称字段中指定的 GitHub 存储库。例如，你要将一个名为 @my-org/test 的包发布到 my-org/test GitHub 存储库。如果运行 npm v8.5.3 或更高版本，则可以通过在包目录中包含 README.md 文件，为包列表页面添加一个摘要。有关详细信息，请参阅 npm 文档中的“使用 package.json”和“如何创建 Node.js 模块”。

通过在 package.json 文件中包含 URL 字段，可以将多个包发布到同一个 GitHub 存储库。有关详细信息，请参阅“将多个包发布到同一存储库”。

可以使用项目中的本地 .npmrc 文件或使用 package.json 中的 publishConfig 选项来设置项目的作用域映射。 GitHub Packages 只支持作用域内的 npm 包。作用域内包的名称格式为 @owner/name。作用域内的包总是以 @ 符号开头。可能需要更新 package.json 中的名称以使用作用域内的名称。例如，"name": "@codertocat/hello-world-npm"。

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

使用本地 .npmrc 文件发布包

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

向 GitHub Packages 验证。有关详细信息，请参阅“向 GitHub Packages 进行身份验证”。 2. 在与 package.json 文件相同的目录中，创建或编辑 .npmrc 文件以包含指定 GitHub Packages URL 和帐户所有者的行。将 OWNER 替换为拥有项目所在存储库的用户或组织帐户的名称。
```
@OWNER: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，则存储库字段应为 https://github.com/my-org/test.git。 1. 发布包：
```
$ npm publish
```

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

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

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

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

若要将多个包发布到同一存储库，可以在每个包的 package.json 文件的 repository 字段中包含 GitHub 存储库的 URL。

为确保仓库的 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 作用域”。

向 GitHub Packages 验证。有关详细信息，请参阅“向 GitHub Packages 进行身份验证”。 2. 在与 package.json 文件相同的目录中，创建或编辑 .npmrc 文件以包含指定 GitHub Packages URL 和帐户所有者的行。将 OWNER 替换为拥有项目所在存储库的用户或组织帐户的名称。
```
@OWNER: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 文件中添加额外的行，将 OWNER 替换为拥有项目所在存储库的用户或组织帐户的名称。

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

本文内容