创建项目
POST/v1/project
当前自适应配置尚在开发中,因此部分配置项还需手动指定,上线后将极大的简化配置项降低接入成本。
请求参数
参数 | 示例 | 说明 |
---|---|---|
name string | blog | 项目名称 |
spec.link object | 项目与代码仓库的联结关系 | |
spec.link.type string | github | 代码仓库的类型,当前仅可选 github |
spec.link.orgID string | 123 | 代码仓库所有者 ID,例如个人用户下的 github 用户 ID,如果是组织用户,则为组织 ID |
spec.link.repoID string | 1637072208 | 代码仓库的 ID |
spec.link.cloneURL string | https://github.com/acme/acme.git | 代码仓库的克隆地址 |
spec.link.branches.production string | main | 用于构建生产环境的分支名称,多为主分支实际情况可以自行选择 |
spec.build.framework string | nodeSSR | 选择用于该项目的框架,目前支持的选项有 nodeSSR、nodeSSG、jekyll、hugo、go、static、hexo |
spec.build.rootDirectory string可选 | workspace | 使用文件夹名称或者相对路径作为项目的工作目录,默认为根目录 |
spec.build.buildCommand string可选 | npm run build | 构建所使用的命令,可主动传入也可留空,默认值将由所选的框架自动判定 |
spec.build.artifactsDirectory string可选 | dist | 项目可能具有构建产物(例如 nodeSSG 静态编译后的 HTML 等),这些产物将被存储在该目录下以作后续使用,默认值将由所选的框架自动判定 |
spec.build.golang.project string可选 | dist | 如果框架为 go,未兼容老旧的包管理方式需要使用该项指定项目相对于 `GOPATH/src` 的路径(相关于 import) |
spec.runtime.servicePort string可选 | 3000 | 服务暴露所在的端口,默认 8080 |
spec.runtime.startCommand string可选 | npm run start | 启动命令,可主动传入也可留空,默认值将由所选的框架自动判定 |
spec.runtime.environments map[string]string可选 | 启动时所带入的环境变量,默认为空 |