Merge remote-tracking branch 'origin/master'

This commit is contained in:
liamjung 2023-01-30 12:00:51 +08:00
commit f2527655fa
17 changed files with 83 additions and 14 deletions

View File

@ -56,7 +56,11 @@ module.exports = {
{
text: '如何部署',
link: '/guide/how-to-deploy',
}]
},{
text: '建木初体验',
link:'/guide/first-project',
}
]
},
{
text: '如何使用',

63
guide/first-project.md Normal file
View File

@ -0,0 +1,63 @@
# 建木初体验
通过示例项目`hello jianmu`体验建木图形化流程编排,完成你的第一个建木流程。
### 操作步骤
1、打开建木图形化编排。
![](./images/first-project-entrance.png)
2、在左侧节点菜单中找到`git clone`和`shell`节点并拖拽到右侧画布上,鼠标移入到`git clone`拖动连接`shell`节点。
![](./images/first-project-chart.png)
3、点击`git clone`节点,在右侧参数抽屉中找到`git地址`,粘贴克隆地址:`https://gitee.com/jianmu-dev/jianmu.git`。
![](./images/first-project-gitclone.png)
4、点击`shell`节点在右侧参数抽屉中选择docker镜像`alpine:3.16.0`。
![](./images/first-project-image.png)
5、新增环境变量。点击`shell`节点右侧参数抽屉中的`添加环境变量+`。输入变量名,点击变量值右侧参数按钮,可以选择对应的参数(只有和上游节点连接后才能选择参数)。
![](./images/first-project-shell.png)
**完整环境变量定义示例:**
![](./images/first-project-shell-show.png)
6、在`shell`节点右侧参数抽屉中的`脚本`中输入以下`echo`命令,执行后的日志中会输出这里定义的环境变量。 脚本示例:
```shell
echo Hello 建木
echo 目录: ${DIR}
echo 分支: ${BRANCH}
echo 标签: ${TAG}
echo id: ${COMMIT_ID}
```
![](./images/first-project-script.png)
7、编辑项目名选择组名后保存并返回。
![](./images/first-project-edit.png)
8、找到刚新建的`hello jianmu`,手动触发这个流程。
![](./images/first-project-trigger.png)
9、点击流程名称进入流程详情页。
![](./images/first-project-detail.png)
10、等待执行结束查看`shell`节点日志即可。
![](./images/first-project-logs.png)
### 展示效果
![](./images/first-project-result.png)

View File

@ -33,29 +33,31 @@ global:
### 并发
`concurrent`可控制当前流程能否并发执行,默认为`false`,表示不能并发执行
`concurrent`可控制当前流程最大并发执行数,默认为`1`,表示最多只能有一个流程实例并发执行
> 版本说明:`v2.2.5`开始支持
语法:
```yaml
global:
# 是否并发执行
# 默认值为false表示不能并发执行此时webhook/cron/手动等操作均无法触发项目并发执行
# 值为true表示可并发执行
concurrent: true | false
# 最大并发执行数,取值范围为 1-9999
# 默认值为1表示最多只能有一个流程实例并发执行此时webhook/cron/手动等操作均无法触发项目并发执行
concurrent: true | false | number
```
**注意:**
> 版本说明:`v2.5.0`开始,流程串行执行时,新触发的流程实例会加入触发队列,排队执行
> * `v2.2.5`开始支持`concurrent`,值为`false`表示串行执行,值为`true`表示可以并发执行
>
> * `v2.5.0`开始,流程串行执行时,新触发的流程实例会加入触发队列,排队执行
>
> * `v2.6.3`开始,`concurrent`支持配置数字。已兼容之前版本的数据,值为`false`等价于数字`1`,值为`true`等价于数字`9`
触发队列最大值默认为5[配置触发队列](./custom-installation.md#后端部署)
流程默认串行执行,触发流程后:
* 若该流程没有运行中的实例,会立即运行该流程实例
* 若该流程有运行中的实例,新触发的流程实例会加入触发队列,排队等待上一个流程实例运行完毕后再运行,若队列已满,会报错
* 若该流程运行数 < 最大并发执行数会立即运行该流程实例
* 若该流程运行数 > 最大并发执行数,新触发的流程实例会加入触发队列,排队等待上一个流程实例运行完毕后再运行,若队列已满,会报错
![img.png](./images/trigger_queue_max.png)
修改串/并行状态
* 串行 -> 并行:串行修改为并行时,若有排队等待的流程实例,会立即并发执行所有排队等待的流程实例
* 并行 -> 串行:并行修改为串行时,以前并发执行的流程实例会继续执行,新触发的流程实例会排队执行
修改`concurrent`配置
* 数字由小变大例如1改为9此时若有排队等待的流程实例会立即并发执行最多8个流程实例执行数 = 最大并发执行数 - 运行中的流程数)
* 数字由大变小例如9改为3,以前并发执行的流程实例会继续执行,新触发的流程实例会排队等待执行

Binary file not shown.

After

Width:  |  Height:  |  Size: 578 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 226 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 593 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 275 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 172 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 311 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 550 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 309 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 262 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 170 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 320 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 324 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 215 KiB

View File

@ -1,6 +1,6 @@
{
"name": "jianmu-docs",
"version": "2.5.5",
"version": "2.6.1",
"repository": "https://gitee.com/jianmu-dev/jianmu-docs.git",
"scripts": {
"dev": "vitepress dev",