b5-简单而理智的任务管理器
b5的Python项目详细描述
b5任务运行器
B5是我们机构(团队23-www.team23.de)所有项目的中心任务管理者。尽量简单一点 尽可能授权你写你自己的任务,扩展现有的任务,并使用B5来完成日常任务。 项目工作。
基本用法和概念
b5 {taskname}
将在项目的build/下查找名为^{task:{taskname}
的函数。
这意味着您可以调用b5 install
来运行函数task:install
。
b5的基本思想是允许您轻松地将日常shell作业放入taskfile并提供
运行这些任务的通用架构。因此b5 css
例如,将始终为
不管这个特定项目中使用的css预处理器是什么(可以是:less,sass,…)。同于B5
使用bash脚本作为taskfile格式,易于理解和增强。
此外,b5还提供了一些模块,以便于在web开发中使用一些常用工具(如 npm,composer,pipenv, docker,…)。此外,它还试图定义一些 common task names为任务命名模式引入一个好的约定。这个 将允许新的开发人员更快地开始项目工作-不需要太在意 项目设置本身。
您可以将参数传递给像b5 some_task some_parameter
这样的任务,并使用普通的bash参数处理
使用这些参数($1
,或者更好的${1}
)。请注意,当访问不存在时,B5将中止。
参数,必要时使用bash默认值(${1:-default}
)。
提示:您可以为所有个人任务添加名为taskfile.local(build/Taskfile.local
)的文件。制造
一定不要将此文件添加到git。请确保将此文件添加到.gitignore中。否则你可能
干扰你学校的本地任务文件。
快速启动
使用pipsi install b5
或pip install b5
安装b5(对于mac os x,您可以在
加上我们的水龙头)。见detailed installation instructions。
请注意我的团队23同事:请确保安装 additional dependencies。
开始您的项目
b5-init example-project cd example-project # start working on the new project
注意:可以使用b5-init -s $SKELETON example
使用骨架初始化项目。默认情况下
b5使用了“基本”框架。有关详细信息,请参见project initialization。
定义任务(构建/任务文件)
b5使用示例taskfile初始化项目(请参见build/Taskfile
)。添加新任务时
编写前缀为task:
的bash函数,例如:
#!/usr/bin/env bash# b5 Taskfile, see https://git.team23.de/build/b5 for details task:make_it_happen(){echo"Yeah, it happened"}
执行任务
现在您可以使用b5 make_it_happen
,并且函数内部的代码将运行。因为这段代码很简单
bash脚本可以使用普通的命令行工具。请随意使用大口、咕噜声、布料等。
复杂的任务执行-并使用任务文件调用它们。
注意:任务文件总是在“运行路径”内执行,默认为build/
。制造
必要时,一定要转换路径。我建议使用子shell(参见
"( … )" subshell syntax)当
这样做。
进一步
现在,您可以设置一个简单的示例项目,其中包括一个示例taskfile。任务文件是 b5任务运行器,它将包括对所有提供的任务的调用。大部分任务 调用外部工具,例如,gulp或fabric。这是预期的行为。
有关b5安装的更多详细信息,请参见detailed installation instruction。
有关b5概念的更多详细信息,请参见core concepts。
有关如何编写任务文件的详细信息,请参见Taskfile format。
有关任务文件所需任务的信息,请参见common tasks。 提供和执行这些任务。
有关如何将配置添加到生成过程以及如何 以处理本地配置。
请参阅modules以进一步了解模块b5已经提供了一个健康的 项目设置。
更多信息请参见project initialization关于如何b5-init
一个项目。
B5标志
当提到b5时,您可以使用b5徽标:
(其他格式见assets/)
在您的项目“B5就绪”后,您还可以随意在项目中添加B5徽章:
(其他格式见assets/badges/)