Skip to content
8 changes: 7 additions & 1 deletion automations/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,18 @@ 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).

For an overview of triggers, update modes, and configuration options shared across all automations, see [Automations](/automations).

## 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

Expand Down Expand Up @@ -47,6 +49,10 @@ For more examples and patterns, see [Use automations](/guides/use-automations).

<GitlabAutomationSetup />

<div id="bitbucket-setup">
<BitbucketAutomationSetup />
</div>

## Delete a custom automation

Deleting an automation is permanent and removes its configuration and run history.
Expand Down
2 changes: 1 addition & 1 deletion automations/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ boost: 5
Automations require a [Pro or Enterprise plan](https://mintlify.com/pricing?ref=automations).
</Info>

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.

Expand Down
10 changes: 8 additions & 2 deletions automations/manage.mdx
Original file line number Diff line number Diff line change
@@ -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)

<Tip>
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.
Expand Down Expand Up @@ -104,6 +106,10 @@

<GitlabAutomationSetup />

<div id="bitbucket-setup">
<BitbucketAutomationSetup />
</div>

## Disable an automation

1. Open the [Automations](https://app.mintlify.com/products/automations) page in your dashboard.
Expand Down Expand Up @@ -135,7 +141,7 @@

Each run shows one of the following statuses:

- **Review needed**: The agent finished the run, but the changes must be reviewed and merged by someone on your team.

Check warning on line 144 in automations/manage.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

automations/manage.mdx#L144

In general, use active voice instead of passive voice ('be reviewed').
- **Running**: The agent is actively working on the automation job.
- **Accepted**: The agent finished the run and the changes merged into your repository.
- **Closed**: The agent finished the run, but someone rejected the changes.
Expand Down
8 changes: 7 additions & 1 deletion es/automations/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,18 @@ 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).

<div id="prerequisites">
## Requisitos previos
</div>

- 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)

<div id="create-a-custom-automation">
## Crear una automatización personalizada
Expand Down Expand Up @@ -51,6 +53,10 @@ Para ver más ejemplos y patrones, consulta [Usar automatizaciones](/es/guides/u

<GitlabAutomationSetup />

<div id="bitbucket-setup">
<BitbucketAutomationSetup />
</div>

<div id="delete-a-custom-automation">
## Eliminar una automatización personalizada
</div>
Expand Down
2 changes: 1 addition & 1 deletion es/automations/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ boost: 5
Las automatizaciones requieren un [plan Pro o Enterprise](https://mintlify.com/pricing?ref=automations).
</Info>

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.

Expand Down
8 changes: 7 additions & 1 deletion es/automations/manage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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';

<div id="prerequisites">
## Requisitos previos
</div>

- 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)

<Tip>
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.
Expand Down Expand Up @@ -124,6 +126,10 @@ Puedes añadir idiomas de destino en cualquier momento abriendo la configuració

<GitlabAutomationSetup />

<div id="bitbucket-setup">
<BitbucketAutomationSetup />
</div>

<div id="disable-an-automation">
## Desactivar una automatización
</div>
Expand Down
8 changes: 7 additions & 1 deletion fr/automations/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,18 @@ 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).

<div id="prerequisites">
## Prérequis
</div>

- 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)

<div id="create-a-custom-automation">
## Créer une automatisation personnalisée
Expand Down Expand Up @@ -51,6 +53,10 @@ Pour plus d'exemples et de modèles, consultez [Utiliser les automatisations](/f

<GitlabAutomationSetup />

<div id="bitbucket-setup">
<BitbucketAutomationSetup />
</div>

<div id="delete-a-custom-automation">
## Supprimer une automatisation personnalisée
</div>
Expand Down
2 changes: 1 addition & 1 deletion fr/automations/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ boost: 5
Les automatisations nécessitent une [offre Pro ou Enterprise](https://mintlify.com/pricing?ref=automations).
</Info>

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.

Expand Down
8 changes: 7 additions & 1 deletion fr/automations/manage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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';

<div id="prerequisites">
## Prérequis
</div>

- 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)

<Tip>
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.
Expand Down Expand Up @@ -124,6 +126,10 @@ Vous pouvez ajouter des langues cibles à tout moment en ouvrant les paramètres

<GitlabAutomationSetup />

<div id="bitbucket-setup">
<BitbucketAutomationSetup />
</div>

<div id="disable-an-automation">
## Désactiver une automatisation
</div>
Expand Down
23 changes: 23 additions & 0 deletions snippets/bitbucket-automation-setup.mdx
Original file line number Diff line number Diff line change
@@ -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

Check warning on line 9 in snippets/bitbucket-automation-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

snippets/bitbucket-automation-setup.mdx#L9

'Configure a Bitbucket deployment' should use sentence-style capitalization.

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.

Check warning on line 19 in snippets/bitbucket-automation-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

snippets/bitbucket-automation-setup.mdx#L19

In general, use active voice instead of passive voice ('are enabled').

Mintlify verifies webhook signatures before processing events. Requests without a valid signature are rejected. Events from unrecognized repositories are ignored.

Check warning on line 21 in snippets/bitbucket-automation-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

snippets/bitbucket-automation-setup.mdx#L21

In general, use active voice instead of passive voice ('are rejected').

Check warning on line 21 in snippets/bitbucket-automation-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

snippets/bitbucket-automation-setup.mdx#L21

In general, use active voice instead of passive voice ('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.
27 changes: 27 additions & 0 deletions snippets/es/bitbucket-automation-setup.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<div id="bitbucket-setup">
## Configuración de Bitbucket
</div>

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.

<div id="configure-a-bitbucket-deployment">
### Configurar un deployment de Bitbucket
</div>

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.
Loading