GitHub Packages 快速入门

通过 GitHub Actions 发布到 GitHub Packages。

注: GitHub 托管的运行器目前在 GitHub Enterprise Server 上不受支持。 您可以在 GitHub 公共路线图 上查看有关未来支持计划的更多信息。

简介

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

发布包

  1. 在 GitHub 上创建新仓库,为节点添加 .gitignore。 更多信息请参阅“创建新仓库”。

  2. 将仓库克隆到本机。

    $ git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY.git
    $ cd YOUR-REPOSITORY
  3. 创建 index.js 文件,并添加基本警报说 "Hello world!"

    JavaScript
    alert("Hello, World!");
  4. 使用 npm init 初始化 npm 包。 在包初始化向导中,输入包名称:@YOUR-USERNAME/YOUR-REPOSITORY,将测试脚本设置为 exit 0。 这将生成一个 package.json 文件,其中包含关于您的包的信息。

    $ npm init
      ...
      package name: @YOUR-USERNAME/YOUR-REPOSITORY
      ...
      test command: exit 0
      ...    
  5. 运行 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
  6. 创建 .github/workflow 目录。 在该目录中,创建一个名为 release-package.yml 的文件。

  7. 将以下 YAML 内容复制到 release-package.yml 文件。

    YAML
    name: Node.js Package
    
    on:
      release:
        types: [created]
    
    jobs:
      build:
        runs-on: ubuntu-latest
        steps:
          - uses: actions/checkout@v2
          - uses: actions/setup-node@v2
            with:
              node-version: 12
          - run: npm ci
          - run: npm test
    
      publish-gpr:
        needs: build
        runs-on: ubuntu-latest
        permissions:
          packages: write
          contents: read
        steps:
          - uses: actions/checkout@v2
          - uses: actions/setup-node@v2
            with:
              node-version: 12
              registry-url: https://npm.pkg.github.com/
          - run: npm ci
          - run: npm publish
            env:
              NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
  8. 告诉 NPM 使用以下方法之一发布包的范围和注册表:

    • 在根目录中创建包含以下内容的 .npmrc 文件,为仓库添加 NPM 配置文件:
      @YOUR-USERNAME:registry=https://npm.pkg.github.com
    • 编辑 package.json 文件,并指定 publishConfig 密钥:
      "publishConfig": {
         "@YOUR-USERNAME:registry": "https://npm.pkg.github.com"
       }
  9. 提交并推送更改到 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
  10. 只要您的仓库中创建新版本,您创建的工作流程就会运行。 如果测试通过,则包将发布到 GitHub Packages。

    要测试这一点,请导航到仓库中的 Code(代码)选项卡,并创建新版本。 更多信息请参阅“管理仓库中的发行版”。

查看已发布的包

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

  1. 在 GitHub Enterprise Server 上,导航到仓库的主页面。

  2. 在文件列表右侧,单击 Packages(包)

    概述页面上的包链接

  3. 单击要查看的包的名称。 包名称

安装已发布的包

现在,您已发布包,您需要使用它作为项目之间的依赖项。 更多信息请参阅“使用 npm 注册表”。

后续步骤

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

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

此文档对您有帮助吗?

隐私政策

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或, 了解如何参与。