535 字约 2 分钟
定制云原生开发启动按钮的外观和行为,让开发者一眼就能认出你的项目。
使用场景
- 为开源项目打造独特的启动体验
- 突出项目的开发环境特色
- 控制开发环境的资源配置(如 CPU 核心数)
- 禁用默认启动按钮(如使用自定义流水线替代)
配置方式
在 .cnb/settings.yml 中添加 workspace 配置:
.cnb/settings.yml
# 云原生开发配置
# 注意:读取云原生启动按钮所在页面当前分支的 .cnb/settings.yml 配置
workspace:
launch:
# 定制云原生开发启动按钮
button:
# 按钮名称
name: 启动云原生开发
# 按钮描述
# 如果值为 null,则不显示默认描述
description: 点击此按钮启动云原生开发环境
# 鼠标悬浮在按钮上显示的图片
# 1.用仓库中当前分支的图片,填写相对仓库根目录的路径,如 .cnb/launch-hover.gif;
# 2.使用当前域名下的文件 raw 地址,比如:https://cnb.cool/my/test/-/git/raw/main/launch-hover.gif
# 图片最大 10MB
hoverImage: .cnb/launch-hover.gif
# CPU 核心数,默认 8,仅对默认模板有效(自定义云原生开发流水线时无效)
cpus: 4
# 是否禁用默认按钮,默认 false
disabled: false
# 环境创建后是否自动打开 WebIDE,默认 false
# 未安装 openssh(仅支持 WebIDE)时,无论此参数为何值,都会自动打开
autoOpenWebIDE: false参数说明
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
workspace.launch.button.name | string | - | 启动按钮的名称 |
workspace.launch.button.description | string | null | - | 按钮描述,设为 null 则不显示默认描述 |
workspace.launch.button.hoverImage | string | - | 鼠标悬浮时显示的图片,支持仓库相对路径或 raw 地址,最大 10MB |
workspace.launch.cpus | number | 8 | CPU 核心数,仅对默认模板有效 |
workspace.launch.disabled | boolean | false | 是否禁用默认启动按钮 |
workspace.launch.autoOpenWebIDE | boolean | false | 环境创建后是否自动打开 WebIDE |
提示
所有参数均为可选参数,按需配置即可。