pkg.pr.new 使用教程

pkg.pr.new 使用教程

pkg.pr.new 📦️ Continuous (Preview) Releases for your libraries! 项目地址: https://gitcode.com/gh_mirrors/pk/pkg.pr.new

1. 项目介绍

pkg.pr.new 是一个开源工具，旨在为开发者提供一种无需发布到 NPM 的预览发布方式。每次提交和拉取请求都会触发一个即时预览发布，使用户能够在等待发布周期或拉取请求合并之前访问到新功能和错误修复。

2. 项目快速启动

安装 GitHub 应用

在开始使用 pkg.pr.new 之前，首先需要在您的 GitHub 仓库中安装 GitHub 应用。确保在尝试发布包之前安装此应用。有关应用所需的权限，请查看相关文档。

添加到您的项目

在你的项目中，通过运行以下命令来安装 pkg.pr.new 作为开发依赖：

npm install --save-dev pkg-pr-new

配置 GitHub 工作流

在您的项目根目录下创建或更新 .github/workflows 目录中的工作流文件，例如 publish.yml。以下是一个示例工作流，它会在每次提交和拉取请求时发布预览包：

name: Publish Any Commit

on:
  push:
  pull_request:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout code
      uses: actions/checkout@v4
    - run: corepack enable
    - uses: actions/setup-node@v4
      with:
        node-version: 20
    - name: Install dependencies
      run: pnpm install
    - name: Build
      run: pnpm build
    - run: pnpm dlx pkg-pr-new publish

发布预览包

在您的 GitHub 工作流中，运行以下命令以发布预览包：

pnpm dlx pkg-pr-new publish

或者如果您使用 yarn：

yarn dlx pkg-pr-new publish

确保该命令在工作流中只运行一次，以避免重复发布。

3. 应用案例和最佳实践

• 即时构建：使用 pkg.pr.new，每次提交都会触发即时构建，用户可以立即测试新功能。
• 无需 NPM 访问：预览发布不依赖 NPM，用户可以直接通过 URL 访问预览包。
• 工作流友好：pkg.pr.new 与 GitHub 工作流无缝集成，可以轻松添加到现有工作流中。
• 简洁的 URL：使用 --compact 选项可以生成更短的 URL，便于分享和使用。

4. 典型生态项目

以下是一些可能使用 pkg.pr.new 的典型生态项目：

• 前端组件库：在组件库的开发过程中，可以快速分享和测试新组件。
• API 服务：为 API 服务创建预览版本，以便在正式发布前进行集成测试。
• 工具库：开发通用工具库时，使用 pkg.pr.new 可以快速获取用户反馈。

通过以上介绍，您应该能够开始使用 pkg.pr.new 并将其集成到您的开发流程中，以便更高效地管理和发布您的开源项目。

pkg.pr.new 📦️ Continuous (Preview) Releases for your libraries! 项目地址: https://gitcode.com/gh_mirrors/pk/pkg.pr.new