lakruzz/play

Play镜像说明

镜像概述

Play是一款声明式执行工具，允许用户通过YAML配置文件（称为manuscript）定义Shell执行逻辑，支持复用代码片段，简化本地CLI操作和CI/CD流程中的任务执行。

核心功能

1. 声明式配置：用YAML文件定义执行步骤，易于维护和复用。
2. 多场景适配：可作为本地CLI工具，也能集成到CircleCI等CI/CD平台。
3. 灵活选项控制：提供指定执行部分、自定义配置文件、详细输出、模拟执行等功能。

使用场景

1. 本地CLI工具：快速执行预定义的Shell任务（如文件处理、脚本运行）。
2. CI/CD集成：在CircleCI平台部署自动化作业（如GitHub Pages部署）。

配置说明

命令选项

• 必填项：--part PART（指定YAML配置中要执行的部分）。
• 可选项：
  • --manuscript MANUSCRIPT：指定自定义配置文件路径（覆盖默认）。
  • --verbose/--noverbose：控制是否输出详细执行信息（默认不输出）。
  • --dryrun：模拟执行（仅输出信息，不实际运行命令，隐含--verbose）。
• 提示：选项支持单/双横线，且可缩写（如-v等价于--verbose，需保证唯一）。

部署示例

本地CLI使用

shell
# 基础运行
docker run lakruzz/play play
# 查看帮助
docker run lakruzz/play play --help

CircleCI作业配置

yaml
prod-deploy:
  working_directory: /app/_site
  docker:
    - image: lakruzz/play:latest
      environment:
        PLAY_TARGET_GH_REPO: lakruzz/stage-circle-lab
        PLAY_USER_NAME: Circle CI by @Lakruzz
        PLAY_USER_*** ***
  steps:
    - restore_cache:
        keys:
          - the-built-repo-{{ .Revision }}
    - run:
        name: Deploy to GitHub Pages
        command: play --manuscript ../.circleci/play-proflow-cci-gh.yml --part ghpages_deploy