diff --git a/guide/flow-dsl.md b/guide/flow-dsl.md index eb3117e58402e76560769a5f36f79ba57e4ee844..d53732659504e698fd7b87908154b39cd19c3336 100644 --- a/guide/flow-dsl.md +++ b/guide/flow-dsl.md @@ -39,6 +39,24 @@ workflow: type: git_clone:latest ``` +### 节点别名 +在流程中定义节点时,可以定义节点的别名,以便更好的区分节点的含义 + +使用`alias`来定义节点的别名 +``` + shell_node: + image: alpine:3.13.6 + alias: Shell节点 + sources: + - start + targets: + - end + script: + - echo hello jianmu +``` +流程可视化界面会显示节点的别名,没有定义别名时,默认显示节点名称 +![](images/flow_node_alias.png) + ### 节点执行顺序 流程从`start`类型的节点开始执行,到`end`类型的节点结束 diff --git a/guide/images/flow_node_alias.png b/guide/images/flow_node_alias.png new file mode 100644 index 0000000000000000000000000000000000000000..15c30e83003f7608846c7f4182978ed3bc31c346 Binary files /dev/null and b/guide/images/flow_node_alias.png differ diff --git a/guide/images/pipeline_node_alias.png b/guide/images/pipeline_node_alias.png new file mode 100644 index 0000000000000000000000000000000000000000..1bbc383cedfe43258759e0de839c23084d195342 Binary files /dev/null and b/guide/images/pipeline_node_alias.png differ diff --git a/guide/pipeline-dsl.md b/guide/pipeline-dsl.md index c0def52d41c36b6ea6fe4a516e268c29d936cdc7..845747c1c3065affda68f5e93d6e85dffd5fd1ce 100644 --- a/guide/pipeline-dsl.md +++ b/guide/pipeline-dsl.md @@ -39,6 +39,20 @@ pipeline: type: git_clone:latest ``` +### 节点别名 +在管道中定义节点时,可以定义节点的别名,以便更好的区分节点的含义 + +使用`alias`来定义节点的别名 +``` + shell_node: + image: alpine:3.13.6 + alias: 测试节点 + script: + - echo hello jianmu +``` +流程可视化界面会显示节点的别名,没有定义别名时,默认显示节点名称 +![](images/pipeline_node_alias.png) + ### 节点执行顺序 管道自上而下依次执行,一个节点只能有一个上游/下游节点,如下: @@ -54,7 +68,8 @@ pipeline: param: hub_url: https://api.jianmu.run dsl_file_path: ${git_clone.git_path} - hub_api_key: ((xxx.xxx)) + hub_api_ak: ((xxx.xxx)) + hub_api_sk: ((xxx.xxx)) ``` ### 节点参数 @@ -69,7 +84,8 @@ pipeline: param: hub_url: https://api.jianmu.run dsl_file_path: ${git_clone.git_path} - hub_api_key: ((xxx.xxx)) + hub_api_ak: ((xxx.xxx)) + hub_api_sk: ((xxx.xxx)) ``` `输入参数`和`输出参数`也可以使用参数方式引用,详情参见[`参数章节`](vars.md) \ No newline at end of file