mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
f072caaf92
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
36 lines
1.6 KiB
Plaintext
36 lines
1.6 KiB
Plaintext
---
|
|
title: "触发预览部署"
|
|
openapi: "/zh/openapi.json POST /project/preview/{projectId}"
|
|
keywords: ["preview", "preview deployment", "branch preview", "staging"]
|
|
---
|
|
|
|
使用此端点以编程方式为 Git 分支创建或更新预览部署。如果指定分支已存在预览，该端点将触发重新部署，而不会创建重复项。
|
|
|
|
响应中包含一个 `statusId`，你可以将其传递给 [Get deployment status](/zh/api/update/status) 以跟踪部署进度。
|
|
|
|
<div id="branch-requirements">
|
|
## 分支要求
|
|
</div>
|
|
|
|
`branch` 必须存在于与你的 Mintlify 项目连接的仓库中。不支持 fork 上的分支。Mintlify GitHub 应用必须安装在仓库上才能构建预览，因此无法从 fork 分支构建预览。有关如何预览来自 fork 的更改，请参阅[Fork 拉取请求](/zh/deploy/preview-deployments#fork-pull-requests)。
|
|
|
|
<div id="use-cases">
|
|
## 用例
|
|
</div>
|
|
|
|
- **CI/CD 流水线**：在拉取请求被打开或更新时自动创建预览部署。
|
|
- **定时预览**：按计划为长期运行的功能分支生成预览。
|
|
- **自定义工具**：将预览创建集成到内部工作流或 Slack 机器人中。
|
|
|
|
<div id="access-to-previews">
|
|
## 预览的访问权限
|
|
</div>
|
|
|
|
通过此端点创建的预览可公开访问，除非你为预览启用了身份验证，该设置会应用于你部署中的所有预览。你无法通过此端点为单个预览设置密码保护。请参阅[限制预览部署的访问权限](/zh/deploy/preview-deployments#restrict-access-to-preview-deployments)。
|
|
|
|
<div id="rate-limits">
|
|
## 速率限制
|
|
</div>
|
|
|
|
此端点允许每个组织每分钟最多 5 个请求。
|