ghaction-chocolatey 镜像文档

镜像概述

ghaction-chocolatey 是一个 GitHub Action，作为 Chocolatey CLI 的包装器，旨在简化 Chocolatey 包的构建与发布流程。通过该 Action，开发者可在 GitHub Actions 工作流中便捷集成 Chocolatey CLI 功能，实现 Chocolatey 包的自动化构建和发布。

核心功能与特性

• Chocolatey CLI 集成：无缝包装 Chocolatey CLI，支持其核心命令与功能
• 包构建支持：提供 Chocolatey 包（.nupkg 文件）的构建能力
• 包发布支持：支持将构建后的包发布到 Chocolatey 社区仓库或私有仓库
• GitHub Actions 兼容：专为 GitHub Actions 环境设计，易于集成到 CI/CD 流程

使用场景与适用范围

• 自动化 Chocolatey 包构建流程，集成至软件开发的持续集成（CI）环节
• 自动化 Chocolatey 包发布流程，集成至软件发布的持续部署（CD）环节
• 适用于需要通过 GitHub Actions 实现 Chocolatey 包生命周期管理的开发团队

使用方法与配置说明

前提条件

• 已启用 GitHub Actions 的 GitHub 仓库
• 若需发布包，需准备 Chocolatey API 密钥（用于仓库认证）

GitHub Actions 工作流配置示例

在仓库的 .github/workflows 目录下创建或编辑工作流文件（如 chocolatey-workflow.yml），添加以下配置：

yaml
name: Chocolatey Package CI/CD

on:
  push:
    branches: [ "main" ]
    paths:
      - '**.nuspec'  # 当nuspec文件变动时触发
      - '.github/workflows/chocolatey-workflow.yml'

jobs:
  build-publish:
    runs-on: windows-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Build and publish Chocolatey package
        uses: crazy-max/ghaction-chocolatey@v4  # 使用最新稳定版本
        with:
          # 核心命令：pack（构建）或 push（发布），可组合使用
          command: pack
          # 包规格文件路径（相对于仓库根目录）
          nuspec: ./src/mypackage/mypackage.nuspec
          # 构建输出目录（可选）
          output_dir: ./artifacts
          # 发布配置（如需发布，取消以下注释并配置）
          # api_key: ${{ secrets.CHOCOLATEY_API_KEY }}  # 从GitHub Secrets获取API密钥
          # source: [***]  # Chocolatey仓库地址

详细文档

完整配置参数、高级用法及故障排除指南，请参考 GitHub 仓库：crazy-max/ghaction-chocolatey