GitHub Packages 快速入门

注意

GitHub Enterprise Server 目前不支持 GitHub 托管的运行器。

简介

在本指南中，您将创建 GitHub Actions 工作流程来测试代码，然后将其发布到 GitHub Packages。

发布您的软件包

在 GitHub 上创建新存储库，并添加 .gitignore 用于 Node.js。有关详细信息，请参阅“创建新仓库”。

将存储库克隆到本地计算机。

git clone https://YOUR-HOSTNAME/YOUR-USERNAME/YOUR-REPOSITORY.git
cd YOUR-REPOSITORY

创建 index.js 文件，并添加一个基本警报，提示“你好，世界！”
JavaScript
```
console.log("Hello, World!");
```
```
console.log("Hello, World!");
```
使用 npm init 初始化 npm 包。在包初始化向导中，输入名称为 @YOUR-USERNAME/YOUR-REPOSITORY 的包，并将测试脚本设置为 exit 0。这将生成一个 package.json 文件，其中包含有关包的信息。
```
$ npm init
  ...
  package name: @YOUR-USERNAME/YOUR-REPOSITORY
  ...
  test command: exit 0
  ...
```

运行 npm install 以生成 package-lock.json 文件，然后提交更改并将其推送到 GitHub。

npm install
git add index.js package.json package-lock.json
git commit -m "initialize npm package"
git push

创建 .github/workflows 目录。在此目录中，创建名为 release-package.yml 的文件。

将以下 YAML 内容复制到 release-package.yml 文件中，将 YOUR-HOSTNAME 替换为企业名称。

YAML

name: Node.js Package

on:
  release:
    types: [created]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
      - uses: actions/setup-node@v4
        with:
          node-version: 20
      - run: npm ci
      - run: npm test

  publish-gpr:
    needs: build
    runs-on: ubuntu-latest
    permissions:
      packages: write
      contents: read
    steps:
      - uses: actions/checkout@v5
      - uses: actions/setup-node@v4
        with:
          node-version: 20
          registry-url: https://npm.YOUR-HOSTNAME.com/
      - run: npm ci
      - run: npm publish
        env:
          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}

name: Node.js Package

on:
  release:
    types: [created]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
      - uses: actions/setup-node@v4
        with:
          node-version: 20
      - run: npm ci
      - run: npm test

  publish-gpr:
    needs: build
    runs-on: ubuntu-latest
    permissions:
      packages: write
      contents: read
    steps:
      - uses: actions/checkout@v5
      - uses: actions/setup-node@v4
        with:
          node-version: 20
          registry-url: https://npm.YOUR-HOSTNAME.com/
      - run: npm ci
      - run: npm publish
        env:
          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}

使用以下方法之一，指定 npm 的作用域和注册表以发布包：
- 在根目录中创建包含以下内容的 .npmrc 文件，为存储库添加 NPM 配置文件：
```
@YOUR-USERNAME:registry=https://npm.pkg.github.com
```
- 编辑 package.json 文件并指定 publishConfig 密钥：
```
"publishConfig": {
  "@YOUR-USERNAME:registry": "https://npm.pkg.github.com"
}
```

提交并推送更改到 GitHub。

$ git add .github/workflows/release-package.yml
# Also add the file you created or edited in the previous step.
$ git add .npmrc or package.json
$ git commit -m "workflow to publish package"
$ git push

只要您的仓库中创建新版本，您创建的工作流程就会运行。如果测试通过，则包将发布到 GitHub Packages。

要测试这一点，请导航到存储库中的“代码”选项卡，并创建新版本。有关详细信息，请参阅在仓库中管理发行版。

查看已发布的包

您可以查看您发布的所有软件包。

安装已发布的包

现在，您已发布该包，您需要在各个项目中将其用作依赖项。有关详细信息，请参阅“在 npm 注册表上工作”。

后续步骤

您刚刚添加的基本工作流程在仓库中创建新版本时运行。但是，这只是您可以对 GitHub Packages 执行操作的开始。您可以通过单个工作流将包发布到多个注册表，并在不同事件（例如合并拉取请求）发生时触发工作流运行，管理容器等。

合并 GitHub Packages 和 GitHub Actions 可以帮助您实现应用程序开发过程几乎每个方面的自动化。准备好开始了吗？以下是一些有用的资源，可用于执行 GitHub Packages 和 GitHub Actions 的后续步骤：

请参阅了解 GitHub Packages，了解有关 GitHub Packages 的深度教程。
有关 GitHub Actions 的深度教程，请参阅撰写工作流程
有关特定用例和示例，请参阅使用 GitHub Packages 注册表

在本文中

简介

发布您的软件包

查看已发布的包

安装已发布的包

后续步骤