# 一键部署按钮

一键部署按钮可以让公开的 Git 项目一键部署到云开发 CloudBase 上,大大简化用户部署的门槛,方便用户快速使用和体验应用。一键部署功能支持 Github,Gitlab,Coding,Gitee 等 Git 仓库地址。

下面是部署按钮的示例,可以尝试点击来一键部署一个 Vue 全栈项目。

英文样式部署按钮

中文样式部署按钮

# 生成您的自定义部署按钮

您可以为自己的项目生成一个自定义的部署按钮,只需要填写下方的表单来生成代码片段,然后就可以嵌入到您的 Git 仓库 README 页面、博客、文章等其他可以展示链接的地方,让用户可以快速一键部署和复制一个前后端应用。

注意

注意:项目需要支持 CloudBase Framework 开发部署,并包含 cloudbaserc.json 配置文件,详细的要求请参考 配置说明 文档。

可以使用公开的 Git 地址如 Github,Gitlab,Gitee Git 仓库地址来生成一个自定义的部署按钮。

# 代码片段

以下是根据您的自定义内容生成的自定义部署按钮的代码片段:

Markdown 代码适合用在 README、Mardkown编写的博客文章等场景

您可以复制下方英文/中文样式的按钮代码,粘贴到 README 等 markdown 文件中

英文样式

[![](https://main.qcloudimg.com/raw/95b6b680ef97026ae10809dbd6516117.svg)](https://console.cloud.tencent.com/tcb/env/index?action=CreateAndDeployCloudBaseProject&appUrl=https%3A%2F%2Fgithub.com%2FTencentCloudBase%2Fcloudbase-templates&workDir=vue&branch=master)

中文样式

[![](https://main.qcloudimg.com/raw/67f5a389f1ac6f3b4d04c7256438e44f.svg)](https://console.cloud.tencent.com/tcb/env/index?action=CreateAndDeployCloudBaseProject&appUrl=https%3A%2F%2Fgithub.com%2FTencentCloudBase%2Fcloudbase-templates&workDir=vue&branch=master)

# 部署按钮是如何工作的?

部署按钮可以让云开发控制台根据指定的 Git 地址来快速帮用户导入一个新项目,并在云端进行云端部署,部署在云开发环境中。云端部署主要是用了 CloudBase Framework (opens new window) 的能力。

# 快速安装部署流程

云开发控制台可以根据链接参数里指定的 Github,Gitlab,Coding,Gitee 等 Git 仓库地址来快速创建一个应用,在创建应用时可以选择创建新的云开发环境或者在已有环境上进行部署。

# URL 参数说明

部署按钮会跳转到如下 URL 地址,用户可以在打开的控制台页面进行登录并选择或者创建环境来部署应用。

https://console.cloud.tencent.com/tcb/env/index?&action=CreateAndDeployCloudBaseProject&appUrl=${应用url(必填)}&appName=${应用名称(可选)}&workDir=${项目目录(可选)}

注意

以下是“部署按钮 URL”中实现每个参数的含义的说明。使用 部署按钮生成器 来创建自己的部署按钮。

# 应用代码地址

参数: appUrl

类型: String

项目所在 Git 仓库地址,

appUrl 参数允许您定义 Git 存储库 URL,如果要部署的项目位于存储库中的子目录,可以选择配置workDir参数来指定,用户在通过云开发控制台导入项目时会自动从指定的 Git 地址来导入代码。

# 分支名

参数: branch

类型: String

使用 branch “分支名”参数可以定义拉取代码时的分支名,例如 master、dev、main 等

# 项目相对目录(可选)

参数: workDir

类型: String

如果要部署的项目的 cloudbaserc.json 位于存储库中的子目录,可以选择配置workDir参数来指定子目录的位置。