cargogenerate/cargo-generate-action

GitHub Action: cargo-generate 模板扩展工具

概述

本GitHub Action旨在在GitHub工作流环境中运行cargo-generate工具，实现项目模板的快速扩展。cargo-generate是Rust生态系统中的模板生成工具，能够基于预定义模板创建标准化项目结构，简化新项目初始化流程。

核心功能与特性

• 集成cargo-generate工具，支持模板扩展操作
• 无缝融入GitHub Actions工作流，实现自动化项目生成
• 支持自定义模板源（Git仓库或本地路径）及输出目录
• 可传递cargo-generate原生参数，满足个性化配置需求

使用场景与适用范围

• Rust项目开发者在GitHub Actions工作流中自动化生成基于模板的项目结构
• 需要通过模板标准化项目初始化流程的团队或个人
• 持续集成/持续部署（CI/CD）流程中需动态生成项目代码的场景

使用方法与配置说明

前置要求

• 运行环境需支持GitHub Actions（GitHub托管Runner或自托管Runner）
• 工作流中需提前配置Rust环境（可通过actions-rs/toolchain等Action实现）

基本配置示例

在GitHub工作流文件（如.github/workflows/generate-project.yml）中添加以下步骤：

yaml
- name: Run cargo-generate
  uses: <action-repo>@v1  # 替换为实际Action的仓库及版本
  with:
    template: https://github.com/example/rust-template.git  # 模板仓库地址
    output-dir: ./new-project  # 输出目录
    extra-args: --name my-project --force  # 传递给cargo-generate的额外参数

参数说明

完整工作流示例

yaml
name: Generate Rust Project
on: [push]

jobs:
  generate:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Set up Rust
        uses: actions-rs/toolchain@v1
        with:
          toolchain: stable

      - name: Generate project from template
        uses: <action-repo>@v1
        with:
          template: https://github.com/rust-lang/cargo-generate-template.git
          output-dir: ./my-new-rust-project
          extra-args: --name my-project --description "A new Rust project generated via GitHub Actions"