终极指南：如何快速将NPM包发布到GitHub Packages

【免费下载链接】starter-workflows Accelerating new GitHub Actions workflows 项目地址: https://gitcode.com/GitHub_Trending/st/starter-workflows

在现代前端开发中，高效管理和发布NPM包是提升开发效率的关键环节。GitHub Packages作为一个集成在GitHub生态系统中的包管理平台，让开发者能够轻松发布、共享和使用代码包。本指南将带你通过简单步骤，利用starter-workflows项目中的自动化工具，实现NPM包的快速发布。

准备工作：了解项目结构

在开始之前，我们需要了解starter-workflows项目中与NPM发布相关的核心文件：

• CI配置文件：项目的ci/目录下提供了两个关键的工作流配置文件
  • npm-publish.yml：用于发布到NPM官方 registry
  • npm-publish-github-packages.yml：专门用于发布到GitHub Packages

这些文件定义了完整的自动化发布流程，包括代码检查、测试和部署步骤。

步骤一：配置package.json文件

要将包发布到GitHub Packages，首先需要正确配置项目的package.json文件。确保包含以下关键字段：

{
  "name": "@username/package-name",
  "version": "1.0.0",
  "publishConfig": {
    "registry": "https://npm.pkg.github.com/"
  }
}

注意：包名必须以@username/开头，其中username是你的GitHub用户名或组织名。

步骤二：设置GitHub Secrets

为了安全地进行身份验证，需要在GitHub仓库中设置必要的密钥：

1. 进入仓库的Settings > Secrets and variables > Actions
2. 添加以下密钥：
   • NODE_AUTH_TOKEN：使用GitHub个人访问令牌(PAT)，需要包含write:packages权限

步骤三：使用工作流配置文件

starter-workflows提供了预配置的工作流文件，你可以直接使用或根据需求进行修改：

GitHub Packages发布工作流解析

npm-publish-github-packages.yml文件定义了完整的发布流程：

• 触发条件：当创建新的GitHub Release时自动触发
• 构建作业：
  • 检出代码并设置Node.js环境
  • 安装依赖并运行测试
• 发布作业：
  • 配置GitHub Packages registry
  • 使用GITHUB_TOKEN进行身份验证
  • 执行npm publish完成发布

关键配置片段：

- uses: actions/setup-node@v4
  with:
    node-version: 20
    registry-url: https://npm.pkg.github.com/
- run: npm publish
  env:
    NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}

步骤四：创建发布并触发工作流

1. 在GitHub仓库页面点击Releases > Draft a new release
2. 填写版本号（遵循语义化版本规范）和发布说明
3. 点击Publish release，自动触发发布工作流

步骤五：验证发布结果

发布完成后，可以通过以下方式验证：

1. 在GitHub仓库的Packages标签页查看已发布的包
2. 在项目中安装测试：

   npm install @username/package-name
   

常见问题解决

• 权限问题：确保GITHUB_TOKEN拥有正确的权限，或检查个人访问令牌的范围
• 包名冲突：确保包名在GitHub Packages中是唯一的
• 版本号问题：每次发布需要使用新的版本号，遵循语义化版本规范

通过使用starter-workflows提供的自动化配置，你可以大幅简化NPM包发布到GitHub Packages的流程，让开发团队更专注于代码质量和功能开发。立即尝试这种高效的包管理方式，提升你的开发工作流！

【免费下载链接】starter-workflows Accelerating new GitHub Actions workflows 项目地址: https://gitcode.com/GitHub_Trending/st/starter-workflows