diff --git a/automations/create.mdx b/automations/create.mdx index 43449d9264..812c79d769 100644 --- a/automations/create.mdx +++ b/automations/create.mdx @@ -5,6 +5,7 @@ keywords: ["automation", "automate", "cron", "agent", "custom automation"] --- import GitlabAutomationSetup from '/snippets/gitlab-automation-setup.mdx'; +import BitbucketAutomationSetup from '/snippets/bitbucket-automation-setup.mdx'; A custom automation runs the agent on a schedule, on repository pushes, or on connected integration events using instructions that you write. Use a custom automation when you need to automate a task that isn't covered by a [predefined automation](/automations/reference). @@ -12,9 +13,10 @@ For an overview of triggers, update modes, and configuration options shared acro ## Prerequisites -- A Mintlify project connected to a GitHub or GitLab repository +- A Mintlify project connected to a GitHub, GitLab, or Bitbucket repository - For GitHub: the [Mintlify GitHub App](/deploy/github) installed on every repository you plan to use in the automation - For GitLab: a connected GitLab account (see [GitLab setup](#gitlab-setup) below) +- For Bitbucket: a connected Bitbucket account (see [Bitbucket setup](#bitbucket-setup) below) ## Create a custom automation @@ -47,6 +49,10 @@ For more examples and patterns, see [Use automations](/guides/use-automations). +
+ +
+ ## Delete a custom automation Deleting an automation is permanent and removes its configuration and run history. diff --git a/automations/index.mdx b/automations/index.mdx index fb2e5e27cb..de1fbb9e7e 100644 --- a/automations/index.mdx +++ b/automations/index.mdx @@ -10,7 +10,7 @@ boost: 5 Automations require a [Pro or Enterprise plan](https://mintlify.com/pricing?ref=automations). -Automations run the agent automatically on a schedule, in response to pushes to a repository, or when an event occurs in a connected integration. Each automation defines a prompt for the agent and a trigger for when to run it. Automations support both GitHub and GitLab repositories with the same triggers, predefined automations, and update modes. Throughout this guide, "pull request" also refers to GitLab merge requests unless noted otherwise. +Automations run the agent automatically on a schedule, in response to pushes to a repository, or when an event occurs in a connected integration. Each automation defines a prompt for the agent and a trigger for when to run it. Automations support GitHub, GitLab, and Bitbucket repositories. Throughout this guide, "pull request" also refers to GitLab merge requests unless noted otherwise. When an automation runs, the agent reads your project content and any connected repositories, then follows the prompt to make updates. diff --git a/automations/manage.mdx b/automations/manage.mdx index 0a0784aa43..55519cb8d2 100644 --- a/automations/manage.mdx +++ b/automations/manage.mdx @@ -1,16 +1,18 @@ --- title: "Manage automations" -description: "Enable, disable, trigger, and delete automations from your dashboard. Configure repository, schedule, and integration triggers; context repos; and automerge." +description: "Manage Mintlify automations from your dashboard. Configure repository, schedule, integration, context repository, and automerge settings." keywords: ["cron", "push", "automerge", "context", "automation instructions", "trigger", "disable automation", "enable automation"] --- import GitlabAutomationSetup from '/snippets/gitlab-automation-setup.mdx'; +import BitbucketAutomationSetup from '/snippets/bitbucket-automation-setup.mdx'; ## Prerequisites -- A Mintlify project connected to a GitHub or GitLab repository +- A Mintlify project connected to a GitHub, GitLab, or Bitbucket repository - For GitHub: the [Mintlify GitHub App](/deploy/github) installed on every repository you plan to use in the automation - For GitLab: a connected GitLab account (see [GitLab setup](#gitlab-setup) below) +- For Bitbucket: a connected Bitbucket account (see [Bitbucket setup](#bitbucket-setup) below) You can also create, list, and delete automations from the terminal with [`mint workflow`](/cli/commands#mint-workflow). The CLI is useful for scripting and CI. The dashboard is the easiest way to configure and monitor automation runs. @@ -104,6 +106,10 @@ You can add target languages at any time by opening the automation's settings an +
+ +
+ ## Disable an automation 1. Open the [Automations](https://app.mintlify.com/products/automations) page in your dashboard. diff --git a/es/automations/create.mdx b/es/automations/create.mdx index 6f45190711..fd688ae35e 100644 --- a/es/automations/create.mdx +++ b/es/automations/create.mdx @@ -5,6 +5,7 @@ keywords: ["automatización", "automatizar", "cron", "agente", "automatización --- import GitlabAutomationSetup from '/snippets/es/gitlab-automation-setup.mdx'; +import BitbucketAutomationSetup from '/snippets/es/bitbucket-automation-setup.mdx'; Una automatización personalizada ejecuta al agente según un calendario, en respuesta a pushes al repositorio o cuando ocurre un evento en una integración conectada, utilizando instrucciones que tú escribes. Usa una automatización personalizada cuando necesites un comportamiento que no cubra una [automatización predefinida](/es/automations/reference), o cuando quieras combinar tu propio prompt con repositorios de contexto e integraciones específicos. Para ver una descripción general de los activadores, modos de actualización y opciones de configuración compartidas entre todas las automatizaciones, consulta [Automatizaciones](/es/automations). @@ -12,9 +13,10 @@ Una automatización personalizada ejecuta al agente según un calendario, en res ## Requisitos previos -- Un proyecto de Mintlify conectado a un repositorio de GitHub o GitLab +- Un proyecto de Mintlify conectado a un repositorio de GitHub, GitLab o Bitbucket - Para GitHub: la [aplicación de GitHub de Mintlify](/es/deploy/github) instalada en cada repositorio que planees usar en la automatización - Para GitLab: una cuenta de GitLab conectada (consulta [Configuración de GitLab](#gitlab-setup) más abajo) +- Para Bitbucket: una cuenta de Bitbucket conectada (consulta [Configuración de Bitbucket](#bitbucket-setup) más abajo)
## Crear una automatización personalizada @@ -51,6 +53,10 @@ Para ver más ejemplos y patrones, consulta [Usar automatizaciones](/es/guides/u +
+ +
+
## Eliminar una automatización personalizada
diff --git a/es/automations/index.mdx b/es/automations/index.mdx index f42b3bf298..bd380192d4 100644 --- a/es/automations/index.mdx +++ b/es/automations/index.mdx @@ -10,7 +10,7 @@ boost: 5 Las automatizaciones requieren un [plan Pro o Enterprise](https://mintlify.com/pricing?ref=automations). -Las automatizaciones ejecutan el agente de forma automática según una programación o en respuesta a cambios en un repositorio o una integración conectada. Cada automatización define un prompt para el agente y un activador que indica cuándo ejecutarla. Las automatizaciones son compatibles con repositorios de GitHub y GitLab, con los mismos activadores, automatizaciones predefinidas y modos de actualización. A lo largo de esta guía, "pull request" también se refiere a los merge requests de GitLab, salvo que se indique lo contrario. +Las automatizaciones ejecutan el agente de forma automática según una programación o en respuesta a cambios en un repositorio o una integración conectada. Cada automatización define un prompt para el agente y un activador que indica cuándo ejecutarla. Las automatizaciones son compatibles con repositorios de GitHub, GitLab y Bitbucket. A lo largo de esta guía, "pull request" también se refiere a los merge requests de GitLab, salvo que se indique lo contrario. Cuando se ejecuta una automatización, el agente lee el contenido de tu proyecto y los repositorios conectados, y luego sigue el prompt para realizar las actualizaciones. diff --git a/es/automations/manage.mdx b/es/automations/manage.mdx index e6662886d9..9ce46829f1 100644 --- a/es/automations/manage.mdx +++ b/es/automations/manage.mdx @@ -5,14 +5,16 @@ keywords: ["cron", "push", "automerge", "contexto", "instrucciones de automatiza --- import GitlabAutomationSetup from '/snippets/es/gitlab-automation-setup.mdx'; +import BitbucketAutomationSetup from '/snippets/es/bitbucket-automation-setup.mdx';
## Requisitos previos
-- Un proyecto de Mintlify conectado a un repositorio de GitHub o GitLab +- Un proyecto de Mintlify conectado a un repositorio de GitHub, GitLab o Bitbucket - Para GitHub: la [aplicación de GitHub de Mintlify](/es/deploy/github) instalada en cada repositorio que planees usar en la automatización - Para GitLab: una cuenta de GitLab conectada (consulta [Configuración de GitLab](#gitlab-setup) más abajo) +- Para Bitbucket: una cuenta de Bitbucket conectada (consulta [Configuración de Bitbucket](#bitbucket-setup) más abajo) También puedes crear, listar y eliminar automatizaciones desde la terminal con [`mint automations`](/es/cli/commands#mint-automations). La CLI es útil para scripts y CI. El dashboard es la forma más sencilla de configurar y supervisar las ejecuciones de automatizaciones. @@ -124,6 +126,10 @@ Puedes añadir idiomas de destino en cualquier momento abriendo la configuració +
+ +
+
## Desactivar una automatización
diff --git a/fr/automations/create.mdx b/fr/automations/create.mdx index 3b4a83e07b..fe5880b675 100644 --- a/fr/automations/create.mdx +++ b/fr/automations/create.mdx @@ -5,6 +5,7 @@ keywords: ["automation", "automate", "cron", "agent", "custom automation"] --- import GitlabAutomationSetup from '/snippets/fr/gitlab-automation-setup.mdx'; +import BitbucketAutomationSetup from '/snippets/fr/bitbucket-automation-setup.mdx'; Une automatisation personnalisée exécute l'agent selon un calendrier, en réponse à des pushes sur un dépôt ou lorsqu'un événement survient dans une intégration connectée, en utilisant les instructions que vous rédigez. Utilisez une automatisation personnalisée lorsque vous avez besoin d'un comportement non couvert par une [automatisation prédéfinie](/fr/automations/reference), ou lorsque vous souhaitez combiner votre propre prompt avec des dépôts de contexte et des intégrations spécifiques. Pour un aperçu des déclencheurs, des modes de mise à jour et des options de configuration communs à toutes les automatisations, consultez [Automatisations](/fr/automations). @@ -12,9 +13,10 @@ Une automatisation personnalisée exécute l'agent selon un calendrier, en répo ## Prérequis
-- Un projet Mintlify connecté à un dépôt GitHub ou GitLab +- Un projet Mintlify connecté à un dépôt GitHub, GitLab ou Bitbucket - Pour GitHub : la [GitHub App Mintlify](/fr/deploy/github) installée sur chaque dépôt que vous prévoyez d'utiliser dans l'automatisation - Pour GitLab : un compte GitLab connecté (voir [Configuration GitLab](#gitlab-setup) ci-dessous) +- Pour Bitbucket : un compte Bitbucket connecté (voir [Configuration Bitbucket](#bitbucket-setup) ci-dessous)
## Créer une automatisation personnalisée @@ -51,6 +53,10 @@ Pour plus d'exemples et de modèles, consultez [Utiliser les automatisations](/f +
+ +
+
## Supprimer une automatisation personnalisée
diff --git a/fr/automations/index.mdx b/fr/automations/index.mdx index 45da11140c..4e01f05fd8 100644 --- a/fr/automations/index.mdx +++ b/fr/automations/index.mdx @@ -10,7 +10,7 @@ boost: 5 Les automatisations nécessitent une [offre Pro ou Enterprise](https://mintlify.com/pricing?ref=automations). -Les automatisations exécutent l'agent automatiquement selon un calendrier ou en réponse à des modifications dans un dépôt ou une intégration connectée. Chaque automatisation définit un prompt pour l'agent et un déclencheur indiquant quand l'exécuter. Les automatisations prennent en charge les dépôts GitHub et GitLab, avec les mêmes déclencheurs, automatisations prédéfinies et modes de mise à jour. Tout au long de ce guide, "pull request" désigne également les merge requests GitLab, sauf indication contraire. +Les automatisations exécutent l'agent automatiquement selon un calendrier ou en réponse à des modifications dans un dépôt ou une intégration connectée. Chaque automatisation définit un prompt pour l'agent et un déclencheur indiquant quand l'exécuter. Les automatisations prennent en charge les dépôts GitHub, GitLab et Bitbucket. Tout au long de ce guide, "pull request" désigne également les merge requests GitLab, sauf indication contraire. Lorsqu'une automatisation s'exécute, l'agent lit le contenu de votre projet et tout dépôt connecté, puis suit le prompt pour effectuer les mises à jour. diff --git a/fr/automations/manage.mdx b/fr/automations/manage.mdx index 80123fd6aa..9b32f67725 100644 --- a/fr/automations/manage.mdx +++ b/fr/automations/manage.mdx @@ -5,14 +5,16 @@ keywords: ["cron", "push", "automerge", "context", "automation instructions", "t --- import GitlabAutomationSetup from '/snippets/fr/gitlab-automation-setup.mdx'; +import BitbucketAutomationSetup from '/snippets/fr/bitbucket-automation-setup.mdx';
## Prérequis
-- Un projet Mintlify connecté à un dépôt GitHub ou GitLab +- Un projet Mintlify connecté à un dépôt GitHub, GitLab ou Bitbucket - Pour GitHub : la [GitHub App Mintlify](/fr/deploy/github) installée sur chaque dépôt que vous prévoyez d'utiliser dans l'automatisation - Pour GitLab : un compte GitLab connecté (voir [Configuration GitLab](#gitlab-setup) ci-dessous) +- Pour Bitbucket : un compte Bitbucket connecté (voir [Configuration Bitbucket](#bitbucket-setup) ci-dessous) Vous pouvez également créer, lister et supprimer des automatisations depuis le terminal avec [`mint automations`](/fr/cli/commands#mint-automations). La CLI est utile pour les scripts et la CI. Le dashboard est le moyen le plus simple de configurer et de surveiller les exécutions d'automatisations. @@ -124,6 +126,10 @@ Vous pouvez ajouter des langues cibles à tout moment en ouvrant les paramètres +
+ +
+
## Désactiver une automatisation
diff --git a/snippets/bitbucket-automation-setup.mdx b/snippets/bitbucket-automation-setup.mdx new file mode 100644 index 0000000000..3cc5c8cedb --- /dev/null +++ b/snippets/bitbucket-automation-setup.mdx @@ -0,0 +1,23 @@ +## Bitbucket setup + +To use Bitbucket repositories in an automation, connect your Bitbucket account through the Bitbucket OAuth settings in your Mintlify dashboard. Authorize Mintlify to access your Bitbucket workspaces, then select the workspaces and repositories that the automation can use. + +Mintlify lists repositories where your Bitbucket account has contributor access. Connect the repositories that the automation uses for content, code-change triggers, or context. Mintlify registers a webhook for each connected repository so repository events can trigger automations. + +Before you configure a connected Bitbucket repository as a deployment Git source, connect that repository in the Bitbucket OAuth settings. Mintlify requires the repository to be part of an active Bitbucket installation before it can use the repository as a Git source. + +### Configure a Bitbucket deployment + +1. Open [Git settings](https://app.mintlify.com/settings/deployment/git-settings) in your dashboard, select **Connect to Bitbucket**, and click **Continue**. +2. If Mintlify currently hosts your documentation, click **Download** to save your content as a zip file. Create a Bitbucket repository, upload the zip contents, and click **Continue setup**. Connecting your own repository permanently deletes the hosted content, so download it before you continue. +3. Click **Connect Bitbucket** and authorize Mintlify to access your workspace and repository. +4. Enter the Bitbucket workspace slug, repository slug, and deploy branch. If `docs.json` is in a subdirectory, enable **Docs are in a subdirectory** and enter the path to the directory containing `docs.json`. +5. Click **Connect**. + +For a connected repository configured as a deployment Git source, pushes to the configured branch trigger deployments. Mintlify uses changed files for incremental updates when it can determine the diff. It runs a full update when it cannot determine changed files or when the change affects the entire site. + +If preview deployments are enabled, pull requests that change documentation content can create preview deployments. Closing a pull request or deleting its source branch removes the matching preview deployment. Merging a pull request cleans up its associated editor branch. + +Mintlify verifies webhook signatures before processing events. Requests without a valid signature are rejected. Events from unrecognized repositories are ignored. + +To stop using a repository, disconnect it from the Bitbucket OAuth settings. You can also remove the Bitbucket installation to disconnect all repositories associated with that authorization. diff --git a/snippets/es/bitbucket-automation-setup.mdx b/snippets/es/bitbucket-automation-setup.mdx new file mode 100644 index 0000000000..b1feaa7ac7 --- /dev/null +++ b/snippets/es/bitbucket-automation-setup.mdx @@ -0,0 +1,27 @@ +
+## Configuración de Bitbucket +
+ +Para usar repositorios de Bitbucket en una automatización, conecta tu cuenta de Bitbucket mediante la configuración de OAuth de Bitbucket en tu dashboard de Mintlify. Autoriza a Mintlify a acceder a tus espacios de trabajo de Bitbucket y, después, selecciona los espacios de trabajo y repositorios que la automatización puede usar. + +Mintlify muestra los repositorios en los que tu cuenta de Bitbucket tiene acceso de colaborador. Conecta los repositorios que la automatización usa para el contenido, los activadores de cambios de código o el contexto. Mintlify registra un webhook para cada repositorio conectado, de modo que los eventos del repositorio puedan activar automatizaciones. + +Antes de configurar un repositorio de Bitbucket conectado como fuente Git de un deployment, conecta ese repositorio en la configuración de OAuth de Bitbucket. Mintlify requiere que el repositorio forme parte de una instalación activa de Bitbucket para poder usarlo como fuente Git. + +
+### Configurar un deployment de Bitbucket +
+ +1. Abre [Configuración de Git](https://app.mintlify.com/settings/deployment/git-settings) en tu dashboard, selecciona **Connect to Bitbucket** y haz clic en **Continue**. +2. Si Mintlify aloja actualmente tu documentación, haz clic en **Download** para guardar tu contenido como archivo zip. Crea un repositorio de Bitbucket, sube el contenido del archivo zip y haz clic en **Continue setup**. Conectar tu propio repositorio elimina permanentemente el contenido alojado, así que descárgalo antes de continuar. +3. Haz clic en **Connect Bitbucket** y autoriza a Mintlify a acceder a tu espacio de trabajo y repositorio. +4. Introduce el slug del espacio de trabajo de Bitbucket, el slug del repositorio y la rama de deployment. Si `docs.json` está en un subdirectorio, activa **Docs are in a subdirectory** e introduce la ruta al directorio que contiene `docs.json`. +5. Haz clic en **Connect**. + +En un repositorio conectado y configurado como fuente Git de un deployment, los pushes a la rama configurada activan deployments. Mintlify usa los archivos modificados para realizar actualizaciones incrementales cuando puede determinar la diferencia. Ejecuta una actualización completa cuando no puede determinar los archivos modificados o cuando el cambio afecta a todo el sitio. + +Si los deployments de vista previa están habilitados, las pull requests que cambien el contenido de la documentación pueden crear deployments de vista previa. Al cerrar una pull request o eliminar su rama de origen, se elimina el deployment de vista previa correspondiente. Al fusionar una pull request, se limpia la rama del editor asociada. + +Mintlify verifica las firmas de los webhooks antes de procesar los eventos. Rechaza las solicitudes sin una firma válida. Ignora los eventos de repositorios no reconocidos. + +Para dejar de usar un repositorio, desconéctalo desde la configuración de OAuth de Bitbucket. También puedes eliminar la conexión de Bitbucket para desconectar todos los repositorios asociados con esa autorización. diff --git a/snippets/fr/bitbucket-automation-setup.mdx b/snippets/fr/bitbucket-automation-setup.mdx new file mode 100644 index 0000000000..0c7385dfd1 --- /dev/null +++ b/snippets/fr/bitbucket-automation-setup.mdx @@ -0,0 +1,27 @@ +
+ ## Configuration Bitbucket +
+ +Pour utiliser des dépôts Bitbucket dans une automatisation, connectez votre compte Bitbucket via les paramètres OAuth Bitbucket de votre dashboard Mintlify. Autorisez Mintlify à accéder à vos espaces de travail Bitbucket, puis sélectionnez les espaces de travail et les dépôts que l'automatisation peut utiliser. + +Mintlify répertorie les dépôts auxquels votre compte Bitbucket dispose d'un accès contributeur. Connectez les dépôts utilisés par l'automatisation pour le contenu, les déclencheurs de modification de code ou le contexte. Mintlify enregistre un webhook pour chaque dépôt connecté afin que les événements du dépôt puissent déclencher des automatisations. + +Avant de configurer un dépôt Bitbucket connecté comme source Git d'un déploiement, connectez ce dépôt dans les paramètres OAuth Bitbucket. Mintlify exige que le dépôt fasse partie d'une installation Bitbucket active pour pouvoir l'utiliser comme source Git. + +
+ ### Configurer un déploiement Bitbucket +
+ +1. Ouvrez les [paramètres Git](https://app.mintlify.com/settings/deployment/git-settings) dans votre dashboard, sélectionnez **Connect to Bitbucket**, puis cliquez sur **Continue**. +2. Si Mintlify héberge actuellement votre documentation, cliquez sur **Download** pour enregistrer votre contenu dans un fichier zip. Créez un dépôt Bitbucket, importez le contenu du fichier zip, puis cliquez sur **Continue setup**. La connexion de votre propre dépôt supprime définitivement le contenu hébergé. Téléchargez-le avant de continuer. +3. Cliquez sur **Connect Bitbucket** et autorisez Mintlify à accéder à votre espace de travail et à votre dépôt. +4. Saisissez le slug de l'espace de travail Bitbucket, le slug du dépôt et la branche de déploiement. Si `docs.json` se trouve dans un sous-répertoire, activez **Docs are in a subdirectory** et saisissez le chemin vers le répertoire contenant `docs.json`. +5. Cliquez sur **Connect**. + +Pour un dépôt connecté et configuré comme source Git d'un déploiement, les pushs vers la branche configurée déclenchent des déploiements. Mintlify utilise les fichiers modifiés pour effectuer des mises à jour incrémentielles lorsqu'il peut déterminer le diff. Il effectue une mise à jour complète lorsqu'il ne peut pas déterminer les fichiers modifiés ou lorsque la modification affecte l'ensemble du site. + +Si les déploiements de prévisualisation sont activés, les pull requests qui modifient le contenu de la documentation peuvent créer des déploiements de prévisualisation. La fermeture d'une pull request ou la suppression de sa branche source supprime le déploiement de prévisualisation correspondant. La fusion d'une pull request nettoie sa branche d'éditeur associée. + +Mintlify vérifie la signature des webhooks avant de traiter les événements. Les requêtes sans signature valide sont rejetées. Les événements provenant de dépôts non reconnus sont ignorés. + +Pour cesser d'utiliser un dépôt, déconnectez-le des paramètres OAuth Bitbucket. Vous pouvez également supprimer l'installation Bitbucket pour déconnecter tous les dépôts associés à cette autorisation. diff --git a/snippets/zh/bitbucket-automation-setup.mdx b/snippets/zh/bitbucket-automation-setup.mdx new file mode 100644 index 0000000000..40ad8958f3 --- /dev/null +++ b/snippets/zh/bitbucket-automation-setup.mdx @@ -0,0 +1,27 @@ +
+ ## Bitbucket 设置 +
+ +要在自动化中使用 Bitbucket 仓库,请通过 Mintlify 控制台中的 Bitbucket OAuth 设置连接 Bitbucket 账户。授权 Mintlify 访问你的 Bitbucket 工作区,然后选择自动化可以使用的工作区和仓库。 + +Mintlify 会列出你的 Bitbucket 账户拥有贡献者访问权限的仓库。连接自动化用于内容更新、代码变更触发器或上下文的仓库。Mintlify 会为每个已连接的仓库注册 webhook,以便仓库事件可以触发自动化。 + +在将已连接的 Bitbucket 仓库配置为部署 Git 源之前,请在 Bitbucket OAuth 设置中连接该仓库。Mintlify 要求仓库属于有效的 Bitbucket 安装,才能将其用作 Git 源。 + +
+ ### 配置 Bitbucket 部署 +
+ +1. 在控制台中打开 [Git 设置](https://app.mintlify.com/settings/deployment/git-settings),选择 **Connect to Bitbucket**,然后点击 **Continue**。 +2. 如果 Mintlify 当前托管你的文档,点击 **Download** 将内容保存为 zip 文件。创建 Bitbucket 仓库,上传 zip 文件中的内容,然后点击 **Continue setup**。连接自己的仓库会永久删除已托管的内容,因此请在继续前下载内容。 +3. 点击 **Connect Bitbucket**,授权 Mintlify 访问你的工作区和仓库。 +4. 输入 Bitbucket 工作区 slug、仓库 slug 和部署分支。如果 `docs.json` 位于子目录中,启用 **Docs are in a subdirectory**,并输入包含 `docs.json` 的目录路径。 +5. 点击 **Connect**。 + +对于已连接并配置为部署 Git 源的仓库,推送到配置的分支会触发部署。Mintlify 能确定差异时,会使用变更文件执行增量更新。如果无法确定变更文件,或变更会影响整个站点,则会执行完整更新。 + +如果已启用预览部署,修改文档内容的拉取请求可以创建预览部署。关闭拉取请求或删除其源分支会移除匹配的预览部署。合并拉取请求会清理相关的编辑器分支。 + +Mintlify 会在处理事件前验证 webhook 签名。没有有效签名的请求会被拒绝。来自未识别仓库的事件会被忽略。 + +要停止使用某个仓库,请在 Bitbucket OAuth 设置中断开连接。你也可以移除 Bitbucket 安装,以断开与该授权关联的所有仓库。 diff --git a/zh/automations/create.mdx b/zh/automations/create.mdx index eabad6ac42..be1f5f2d04 100644 --- a/zh/automations/create.mdx +++ b/zh/automations/create.mdx @@ -1,10 +1,11 @@ --- title: "创建自定义自动化" -description: "创建 Mintlify 自动化,按计划、仓库推送或集成事件运行。添加上下文仓库和自定义 agent 提示词。" +description: "创建 Mintlify 自动化,按计划、仓库推送或集成事件运行 agent。添加上下文仓库和自定义提示词,连接 GitHub、GitLab 或 Bitbucket 仓库,并配置文档内容、代码变更和集成触发器。了解如何设置运行计划、更新模式、目标分支、拉取请求和集成条件,让自动化按照项目工作流可靠执行。" keywords: ["automation", "automate", "cron", "agent", "custom automation"] --- import GitlabAutomationSetup from '/snippets/zh/gitlab-automation-setup.mdx'; +import BitbucketAutomationSetup from '/snippets/zh/bitbucket-automation-setup.mdx'; 自定义自动化使用你编写的指令,按计划、在仓库推送时或在已连接的集成事件发生时运行 agent。当[预定义自动化](/zh/automations/reference)无法覆盖你需要的行为,或者你希望将自己的提示词与特定的上下文仓库和集成组合在一起时,使用自定义自动化。有关所有自动化共享的触发器、更新模式和配置选项的概述,请参见[自动化](/zh/automations)。 @@ -12,9 +13,10 @@ import GitlabAutomationSetup from '/snippets/zh/gitlab-automation-setup.mdx'; ## 前置条件
-- 一个已连接到 GitHub 或 GitLab 仓库的 Mintlify 项目 +- 一个已连接到 GitHub、GitLab 或 Bitbucket 仓库的 Mintlify 项目 - 对于 GitHub:在你计划用于自动化的每个仓库上都安装 [Mintlify GitHub 应用](/zh/deploy/github) - 对于 GitLab:已连接的 GitLab 账户(请参见下方[GitLab 设置](#gitlab-setup)) +- 对于 Bitbucket:已连接的 Bitbucket 账户(请参见下方[Bitbucket 设置](#bitbucket-setup))
## 创建自定义自动化 @@ -51,6 +53,10 @@ import GitlabAutomationSetup from '/snippets/zh/gitlab-automation-setup.mdx'; +
+ +
+
## 删除自定义自动化
diff --git a/zh/automations/index.mdx b/zh/automations/index.mdx index 0b0eaf2854..9e3e733f0f 100644 --- a/zh/automations/index.mdx +++ b/zh/automations/index.mdx @@ -1,7 +1,7 @@ --- title: "自动化概览" sidebarTitle: "概览" -description: "使用 Mintlify 自动化,自动维护内容:按计划、在仓库推送时或在已连接集成的事件上运行 agent。" +description: "使用 Mintlify 自动化维护文档内容,让 agent 按计划、在 GitHub、GitLab 或 Bitbucket 仓库推送时,或在已连接集成的事件上运行。了解预定义和自定义自动化、触发器、更新模式、上下文仓库与运行记录,选择适合团队工作流的配置方式。" keywords: ["automation", "automate", "cron", "agent", "automations"] boost: 5 --- @@ -10,7 +10,7 @@ boost: 5 自动化需要 [Pro 或 Enterprise 方案](https://mintlify.com/pricing?ref=automations)。 -自动化会按计划,或在仓库或已连接集成发生变更时自动运行 agent。每个自动化都会为 agent 定义一个提示词,以及触发其运行的条件。自动化同时支持 GitHub 和 GitLab 仓库,二者具备相同的触发器、预定义自动化和更新模式。在本指南中,除非另有说明,"pull request" 也指 GitLab 的 merge request。 +自动化会按计划,或在仓库或已连接集成发生变更时自动运行 agent。每个自动化都会为 agent 定义一个提示词,以及触发其运行的条件。自动化支持 GitHub、GitLab 和 Bitbucket 仓库。在本指南中,除非另有说明,“pull request” 也指 GitLab 的 merge request。 当自动化运行时,agent 会读取你的项目内容以及任何已连接的仓库,然后按照提示词进行更新。 diff --git a/zh/automations/manage.mdx b/zh/automations/manage.mdx index 94297e7d5d..005941c87a 100644 --- a/zh/automations/manage.mdx +++ b/zh/automations/manage.mdx @@ -1,18 +1,20 @@ --- title: "管理自动化" -description: "从控制台启用、禁用、触发和删除自动化。配置仓库、计划和集成触发器、上下文仓库及 automerge。" +description: "从 Mintlify 控制台管理自动化,启用、禁用、触发和删除任务,并配置 GitHub、GitLab 或 Bitbucket 仓库、计划、集成触发器和上下文仓库。了解如何编辑提示词、更新模式、目标语言、拉取请求和自动合并设置,持续监控运行结果并调整项目工作流。" keywords: ["cron", "push", "automerge", "context", "automation instructions", "trigger", "disable automation", "enable automation"] --- import GitlabAutomationSetup from '/snippets/zh/gitlab-automation-setup.mdx'; +import BitbucketAutomationSetup from '/snippets/zh/bitbucket-automation-setup.mdx';
## 前置条件
-- 一个已连接到 GitHub 或 GitLab 仓库的 Mintlify 项目 +- 一个已连接到 GitHub、GitLab 或 Bitbucket 仓库的 Mintlify 项目 - 对于 GitHub:在你计划用于自动化的每个仓库上都安装 [Mintlify GitHub 应用](/zh/deploy/github) - 对于 GitLab:已连接的 GitLab 账户(请参见下方[GitLab 设置](#gitlab-setup)) +- 对于 Bitbucket:已连接的 Bitbucket 账户(请参见下方[Bitbucket 设置](#bitbucket-setup)) 你也可以通过 [`mint automations`](/zh/cli/commands#mint-automations) 在终端中创建、列出和删除自动化。CLI 适合用于脚本和 CI。控制台是配置和监控自动化运行最简单的方式。 @@ -124,6 +126,10 @@ import GitlabAutomationSetup from '/snippets/zh/gitlab-automation-setup.mdx'; +
+ +
+
## 禁用自动化