Bashful YAML语法全解析：从基础到高级的配置技巧

Bashful YAML语法全解析：从基础到高级的配置技巧

【免费下载链接】bashfulUse a yaml file to stitch together commands and bash snippits and run them with a bit of style. Why? Because your bash script should be quiet and shy-like (...and not such a loud mouth).项目地址: https://gitcode.com/gh_mirrors/bas/bashful

Bashful是一款强大的命令行工具，它允许用户通过YAML文件来组织和执行命令序列，让bash脚本变得更加优雅和易于维护。本文将全面解析Bashful的YAML语法，从基础配置到高级技巧，帮助你快速掌握这个工具的使用方法。

什么是Bashful？

Bashful是一个基于YAML的命令编排工具，它可以将复杂的bash命令序列组织成结构化的YAML文件，从而实现更清晰、更可维护的脚本逻辑。通过Bashful，你可以轻松定义任务序列、并行执行任务、处理错误等，让你的命令行工作流更加高效。

基础YAML配置结构

Bashful的YAML配置文件主要包含两个核心部分：config和tasks。

1. 配置部分（config）

config部分用于设置全局参数，例如日志路径、是否折叠完成的任务等。

config: # 可选：将所有输出记录到指定文件 log-path: build.log # 可选：任务完成后是否折叠显示 collapse-on-completion: true

2. 任务部分（tasks）

tasks部分是配置文件的核心，用于定义要执行的命令序列。每个任务可以包含以下几个关键属性：

• name：任务名称（可选）
• cmd：要执行的命令
• parallel-tasks：并行执行的子任务列表
• for-each：用于循环执行相同命令的参数列表

基础任务定义

最简单的Bashful配置只需要包含tasks部分，每个任务指定cmd即可：

tasks: - cmd: example/scripts/random-worker.sh 10 - cmd: example/scripts/random-worker.sh 2

为了提高可读性，建议为每个任务添加name：

tasks: - name: Prepping data cmd: example/scripts/random-worker.sh 10 - name: Packaging RPM cmd: example/scripts/random-worker.sh 2

Bashful执行示例：通过YAML配置文件运行命令序列

并行任务执行

Bashful支持并行执行多个任务，只需使用parallel-tasks属性：

tasks: - name: Compiling source parallel-tasks: - name: Compiling aux libraries cmd: example/scripts/compile-something.sh 2 - name: Compiling app (debug) cmd: example/scripts/compile-something.sh 9 - name: Compiling app (release) cmd: example/scripts/compile-something.sh 6 - name: Compiling app (with trace) cmd: example/scripts/compile-something.sh 4

循环任务执行

当需要对多个参数执行相同命令时，可以使用for-each结合YAML锚点来实现：

1. 定义引用数据

首先在配置文件中定义一个引用数据部分（通常命名为x-reference-data）：

x-reference-data: all-apps: &app-names - some-lib-4 - utilities-lib - important-lib - some-app1 - some-app3 - some-awesome-app-5 - watcher-app - yup-another-app-7

2. 在任务中使用for-each

然后在任务中使用for-each引用这个数据列表，使用<replace>作为参数占位符：

tasks: - name: Cloning <replace> cmd: example/scripts/random-worker.sh 4 <replace> for-each: *app-names

高级并行循环

Bashful还支持在并行任务中使用循环，实现更复杂的执行逻辑：

tasks: - name: Cloning Repos parallel-tasks: - name: "Cloning <replace>" cmd: example/scripts/random-worker.sh 4 <replace> for-each: *app-names

任务折叠功能

Bashful提供了任务折叠功能，可以在任务完成后隐藏详细输出，只显示任务标题：

config: # 全局设置：所有并行任务完成后折叠 collapse-on-completion: true tasks: - name: Building and Migrating # 为特定任务单独设置：不折叠 collapse-on-completion: false parallel-tasks: - name: "Building <replace>" cmd: example/scripts/compile-something.sh 4 <replace> for-each: *app-names

完整示例

下面是一个综合运用上述技巧的完整示例：

config: log-path: build.log collapse-on-completion: true x-reference-data: all-apps: &app-names - some-lib-4 - utilities-lib - important-lib - some-app1 - some-app3 - some-awesome-app-5 - watcher-app - yup-another-app-7 tasks: - name: Prepping data cmd: example/scripts/random-worker.sh 10 - name: Cloning Repos parallel-tasks: - name: "Cloning <replace>" cmd: example/scripts/random-worker.sh 4 <replace> for-each: *app-names - name: Compiling source parallel-tasks: - name: Compiling aux libraries cmd: example/scripts/compile-something.sh 2 - name: Compiling app (debug) cmd: example/scripts/compile-something.sh 9 - name: Compiling app (release) cmd: example/scripts/compile-something.sh 6 - name: Compiling app (with trace) cmd: example/scripts/compile-something.sh 4 - name: Building and Migrating collapse-on-completion: false parallel-tasks: - name: "Building <replace>" cmd: example/scripts/compile-something.sh 4 <replace> for-each: *app-names - name: Cleaning up workspace cmd: example/scripts/random-worker.sh 10

如何开始使用Bashful

要开始使用Bashful，首先需要克隆仓库：

git clone https://gitcode.com/gh_mirrors/bas/bashful

然后根据上述语法创建你的YAML配置文件，最后使用以下命令执行：

./bin/bashful your-config.yml

通过本文介绍的Bashful YAML语法，你可以轻松构建复杂的命令执行流程，提高工作效率。无论是日常脚本还是复杂的构建流程，Bashful都能帮助你以更优雅的方式管理命令序列。

【免费下载链接】bashfulUse a yaml file to stitch together commands and bash snippits and run them with a bit of style. Why? Because your bash script should be quiet and shy-like (...and not such a loud mouth).项目地址: https://gitcode.com/gh_mirrors/bas/bashful