lsstsqre/templatebot

api.lsst.codes 模板项目创建服务

镜像概述

该镜像是api.lsst.codes生态系统中的核心微服务之一，专门用于从模板仓库生成新的项目和文件。它通过自动化模板渲染流程，简化项目初始化工作，帮助用户快速创建符合规范的项目结构。

核心功能与特性

• 模板驱动项目生成：支持从指定的模板仓库拉取模板资源，自动创建新项目结构
• 文件级模板渲染：可根据模板定义生成单个或多个项目文件，确保文件格式标准化
• 与api.lsst.codes集成：作为微服务组件，可无缝对接api.lsst.codes平台的其他服务
• 灵活配置：支持通过环境变量和配置文件自定义模板源、输出路径等参数

使用场景

• 开发团队项目初始化：快速创建符合团队规范的新项目框架
• 自动化项目部署：在CI/CD流程中自动生成项目文件，支持持续集成/部署
• 标准化文件生成：确保组织内所有项目使用统一的文件结构和格式
• 模板管理与分发：集中管理项目模板，实现模板的版本控制和复用

使用方法

基本运行命令

bash
docker run -d \
  --name template-service \
  -e TEMPLATE_REPO_URL=https://github.com/lsst/templates.git \
  -e OUTPUT_PATH=/projects \
  -v ./local-projects:/projects \
  lsst/api-template-service

环境变量配置

Docker Compose配置示例

yaml
version: '3.8'
services:
  template-service:
    image: lsst/api-template-service
    container_name: lsst-template-service
    restart: unless-stopped
    environment:
      - TEMPLATE_REPO_URL=https://github.com/lsst/templates.git
      - TEMPLATE_BRANCH=production
      - OUTPUT_PATH=/data/projects
      - LOG_LEVEL=INFO
    volumes:
      - ./projects:/data/projects
      - ./template-cache:/app/cache
    ports:
      - "8080:8080"

工作流程说明

1. 服务启动后，会从TEMPLATE_REPO_URL拉取指定分支的模板仓库
2. 用户通过API请求指定模板名称和项目参数
3. 服务根据模板渲染生成项目文件，并输出到OUTPUT_PATH指定的目录
4. 生成结果通过API返回给用户，包含项目创建状态和文件列表