diff --git a/.vitepress/config.js b/.vitepress/config.js index 7ee77081750ce97f8261ddf86d7314ef2772ea83..bd5d2824ab329bc0ad4c2bb3a4350eacded3cfa6 100644 --- a/.vitepress/config.js +++ b/.vitepress/config.js @@ -56,7 +56,11 @@ module.exports = { { text: '如何部署', link: '/guide/how-to-deploy', - }] + },{ + text: '建木初体验', + link:'/guide/first-project', + } + ] }, { text: '如何使用', diff --git a/guide/first-project.md b/guide/first-project.md new file mode 100644 index 0000000000000000000000000000000000000000..eabbd2410ff0a909ae2a44af125171f0bea2eb57 --- /dev/null +++ b/guide/first-project.md @@ -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) diff --git a/guide/images/first-project-chart.png b/guide/images/first-project-chart.png new file mode 100644 index 0000000000000000000000000000000000000000..78f1aef355c11961d0c6d73ee32a66943c996c7f Binary files /dev/null and b/guide/images/first-project-chart.png differ diff --git a/guide/images/first-project-detail.png b/guide/images/first-project-detail.png new file mode 100644 index 0000000000000000000000000000000000000000..ffdccbaf41ed69a2fd5bf947915878f4bb50afc2 Binary files /dev/null and b/guide/images/first-project-detail.png differ diff --git a/guide/images/first-project-edit.png b/guide/images/first-project-edit.png new file mode 100644 index 0000000000000000000000000000000000000000..7be9682e3349a9b9487475a6f261891718e5bfea Binary files /dev/null and b/guide/images/first-project-edit.png differ diff --git a/guide/images/first-project-entrance.png b/guide/images/first-project-entrance.png new file mode 100644 index 0000000000000000000000000000000000000000..39165561a4cd9e6686991dfb009ada1176eb829f Binary files /dev/null and b/guide/images/first-project-entrance.png differ diff --git a/guide/images/first-project-gitclone.png b/guide/images/first-project-gitclone.png new file mode 100644 index 0000000000000000000000000000000000000000..cc24605e6124f6a3204c7e8268903f7a85f8f297 Binary files /dev/null and b/guide/images/first-project-gitclone.png differ diff --git a/guide/images/first-project-image.png b/guide/images/first-project-image.png new file mode 100644 index 0000000000000000000000000000000000000000..9101fbb0727acd26245a12866bcddff2b3bc70cd Binary files /dev/null and b/guide/images/first-project-image.png differ diff --git a/guide/images/first-project-logs.png b/guide/images/first-project-logs.png new file mode 100644 index 0000000000000000000000000000000000000000..6eb4b5f062ffe524aefd1ce8e0482d20750e6922 Binary files /dev/null and b/guide/images/first-project-logs.png differ diff --git a/guide/images/first-project-result.png b/guide/images/first-project-result.png new file mode 100644 index 0000000000000000000000000000000000000000..0d2a6068eff1faa124d8708b7486a58bcb19ef7a Binary files /dev/null and b/guide/images/first-project-result.png differ diff --git a/guide/images/first-project-script.png b/guide/images/first-project-script.png new file mode 100644 index 0000000000000000000000000000000000000000..2da85ce746d038bfc471ee1de598ecf0466354d9 Binary files /dev/null and b/guide/images/first-project-script.png differ diff --git a/guide/images/first-project-shell-show.png b/guide/images/first-project-shell-show.png new file mode 100644 index 0000000000000000000000000000000000000000..69aea46be68775e4eec2f924f27bb7a6f78171c6 Binary files /dev/null and b/guide/images/first-project-shell-show.png differ diff --git a/guide/images/first-project-shell.png b/guide/images/first-project-shell.png new file mode 100644 index 0000000000000000000000000000000000000000..ec7115fb55b8cccd271c2aa5c5596a50360ed893 Binary files /dev/null and b/guide/images/first-project-shell.png differ diff --git a/guide/images/first-project-show.png b/guide/images/first-project-show.png new file mode 100644 index 0000000000000000000000000000000000000000..82a611f95fa7f679c7ab32f4da6ba883c5f4b94f Binary files /dev/null and b/guide/images/first-project-show.png differ diff --git a/guide/images/first-project-trigger.png b/guide/images/first-project-trigger.png new file mode 100644 index 0000000000000000000000000000000000000000..ea6c9505e730cc94f05ac3261627a5e7d0bbd84a Binary files /dev/null and b/guide/images/first-project-trigger.png differ