plan mac {
  reach goal_task via (Profile: debug) * (Os: mac)
}

plan win {
  reach goal_task via (Profile: debug) * (Os: windows)
}

值

工作流程中有几种类型的值

# literal values without spaces can be unquoted:
unquoted_var=literal_value_with_no_spaces
unquoted_var2=/literals/can/also/be/paths

# literal values can be written in double quotes
sentence="put a whole sentence in double quotes"

# values can refer to other values:
renamed=$unquoted_var

# interpolate variables in double quotes:
interpolated="the sentence above is: $sentence"

# the path to a task output can be specified with '@'.
# this variable contains the path to the output file "output_var_name" from the task "task_name":
task_output=$output_var_name@task_name

# values can be *branched* with parentheses.
# this variable has value "brew" on branch (Os: mac), "choco" on branch (Os: windows), etc.:
pkg_mgr=(Os: mac=brew windows=choco ubuntu=apt-get)

# when we want to create a value with the same name as a branchpoint, we can omit the value name.
# this assignment is shorthand for profile=(Debug: debug=debug release=release):
profile=(Debug: debug release)

# another example of a branched value using shorthand notation:
os=(Os: mac windows ubuntu)

# a value evaluated for a specific branch (a "branch graft") can be specified with brackets.
# this variable has the value of the variable "profile" on branch (Profile: release),
# regardless of which branch is currently being evaluated:
grafted=$profile[Profile: release]

# branch grafts can be combined with task outputs:
task_output_release=$output_var_name@task_name[Profile: release]

全局配置

值可以在一个global块中指定，每行一个

global {
  var1="hi there"
  var2=$output@some_task
}

这些值然后可以在工作流程中的任何任务中使用。

任务

任务是工作流程文件中大部分逻辑所在的地方。它们看起来像这样

task cargo_build
  @cargo
  > lib="target/$profile/myrustlib"
  :: release_flag=(Profile: debug="" release="--release")
{
  cargo build $release_flag
}

这告诉hr创建一个任务

• 在cargo模块目录中运行（模块将在下面解释）
• 生成一个输出，该输出由 hr 所知，称为 lib，并位于 target/$profile/myrustlib（这将评估为 target/debug/myrustlib 或 target/release/myrustlib，具体取决于我们正在评估哪个分支：(Profile: debug) 或 (Profile: release)）。
• 接受一个名为 release_flag 的参数，该参数的定义取决于我们是否处于 (Profile: debug) 或 (Profile: release) 状态。
• 运行命令 cargo build $release_flag。

在开括号之前的内容被称为 任务头。任务头由一个名称和一个可选的值列表组成，用于定义任务如何运行及其与其他任务的关系。这些值可以是以下任意之一

• 任意数量的输入文件，使用 <（上面未显示）指定。
• 任意数量的输出文件，使用 > 指定。
• 任意数量的参数，使用 :: 指定。
• 零个或一个模块定义，使用 @ 指定。

在头中定义的任何输入、输出和参数的变量名都可用于下面的代码块中（见上面代码中如何使用 $release_flag）。

（除模块外）这些值使用与上面相同的值语法，例如

< input=(Branched: branch1=val1 branch2=val2)
> output1=$config_var_defined_in_a_global_block
> output2="put/$variable_interpolation/in/double-quotes"
:: param1=$grafted_variable[Branchpoint: branch1]

可以在空格分隔的列表中定义单个类型的多个任务值

< input1=foo input2=bar

并且可以在单行上定义这些列表的多个

< input1=foo input2=bar > output=output :: param1=x param2=y

此外，任务值中还有一些在全局块中不可用的缩写。任何没有等号的输入或输出值

< input
> output

将被解释为与

< input=input
> output=output

这在你例如不关心输出文件的名称，只关心它存在的情况下很有用。

参数可以用 @ 符号指定，如下所示

param=@

这告诉 workflow 在全局块中查找名为 param 的变量，并使用其值。还有一些其他快捷方式我们在这里不会介绍，请参见示例目录以获取更多信息。

输入（<）

任务输入是文件，它们与其他任务值的主要区别在于在任务运行之前会检查它们的存在。如果任务定义的任何输入文件在任务运行前不存在，则执行停止。《code>workflow 不关心它们是文件还是目录，只关心它们存在。

与其他值一样，它们可以分支或接枝。

输出（>）

任务的输出是文件，它们与其他任务值的不同之处在于它们在任务运行后会进行存在性检查。如果一个任务的定义输出文件在任务运行后立即不存在，则认为任务失败，执行停止。 workflow 不关心输出是文件还是目录，只关心它们是否存在。而且，像其他值一样，它们可以进行分支或嫁接。

输出应定义为相对于任务代码将运行的目录的相对路径（关于任务目录的更多内容稍后介绍）。

params (::)

在任何时候都不会检查参数的存在性。它们可以定义为文本字符串，或是对其他地方定义的配置值的引用，但不能是任务输出。

modules (@)

模块只是一个前面带有 @ 符号的单一标识符，例如 @cargo。为了使类似于 task cargo_build @cargo 的任务头正常工作，必须在配置文件的某个地方定义一个名为 cargo 的模块，如下所示：

module cargo=/home/me/code/my-crate

通常，对于未指定 @module 的任务，workflow 将为每次任务执行创建一个新的目录并在其中运行其代码。所有输出都被假定为相对于这个新目录，并且依赖于它们的其他任务将期望在那里找到它们。

对于 @module 任务，workflow 将在模块目录中执行代码，然后将输出文件从模块目录复制回任务目录（其他任务可以在那里找到它们）。

这对于构建命令非常有用，这些命令依赖于存在于特定位置的源代码，并且我们不一定想每次运行工作流程时都将其复制到新目录中。请参阅 examples 以获取示例。

使任务无效

-x 标志告诉 hr 使已运行的某个任务无效

> hr -x -t pkgbuild -b Framework=vst

上述操作将使分支 (Framework: vst) 的 pkgbuild 任务无效。这意味着下次运行工作流程时，将重新运行该任务，无论它是否成功。由于它们的输入现在被认为是无效的，因此该任务的所有依赖任务也将重新运行。

指定任务名称的 -t 标志始终是必需的，但指定分支的 -b 标志是可选的。如果省略，hr 将使所有分支上的该任务的所有实现无效。

对于更复杂的分支，可以一起指定多个分支点，要么使用多个 -b 标志

> hr -x -t pkgbuild -b Framework=vst -b Profile=release

或者通过 + 将它们链接在一起

> hr -x -t pkgbuild -b Framework=vst+Profile=release