Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 25 additions & 6 deletions es/guides/configure-automerge.mdx
Original file line number Diff line number Diff line change
@@ -1,14 +1,21 @@
---
title: "Configurar automerge para aplicaciones GitHub"
sidebarTitle: "Configurar automerge"
description: "Configura flujos de trabajo de GitHub para fusionar automáticamente pull requests de Mintlify añadiendo el bot de Mintlify a la lista de exclusión de reglas de tu repositorio."
keywords: ["automerge", "ruleset", "protección de rama", "bypass"]
description: "Configura la fusión automática de PR de Mintlify habilitando squash merge y permitiendo que la aplicación GitHub de Mintlify omita las reglas de rama."
keywords: ["automerge", "ruleset", "protección de rama", "bypass", "squash merge"]
---

Agrega la aplicación GitHub de Mintlify a la lista de bypass de un ruleset para que la aplicación pueda crear y fusionar pull requests sin que los requisitos de revisión y verificaciones de estado la bloqueen. Esto te permite configurar [flujos de trabajo](/workflows/index) para fusionar automáticamente los cambios a `main`.
Configura tu repositorio para que la aplicación GitHub de Mintlify pueda crear y fusionar pull requests sin que los requisitos de revisión y verificaciones de estado la bloqueen. Esto te permite configurar [flujos de trabajo](/workflows/index) que fusionen automáticamente los cambios a `main`.

Automerge requiere dos cosas en tu repositorio:

1. **Squash merge está habilitado.** Mintlify usa squash merge para integrar los PR.
2. **La aplicación GitHub de Mintlify puede hacer bypass de las reglas de rama.** Agrega la aplicación a la lista de bypass de cada ruleset o regla de protección de rama clásica que requiera revisiones en tu rama de implementación.

El panel muestra un banner de configuración de automerge en la página de Workflows si falta alguno de estos requisitos. Usa los enlaces del banner para ir directamente a la configuración de GitHub que necesitas actualizar.

<Note>
La aplicación GitHub de Mintlify debe tener permisos de bypass en **todos** los rulesets que apunten a tu rama de implementación, incluyendo los rulesets definidos a nivel de organización y a nivel de repositorio. Si algún ruleset no tiene la entrada de bypass, el flujo de trabajo crea un PR, pero no lo fusiona.
La aplicación GitHub de Mintlify debe tener permisos de bypass en **todos** los rulesets y reglas de protección de rama que apunten a tu rama de implementación, incluyendo los definidos a nivel de organización y a nivel de repositorio. Si alguna regla no tiene la entrada de bypass, el flujo de trabajo crea un PR, pero no lo fusiona.
</Note>

<div id="prerequisites">
Expand All @@ -17,10 +24,19 @@ Agrega la aplicación GitHub de Mintlify a la lista de bypass de un ruleset para

- Acceso de administrador al repositorio (y acceso de administrador a la organización si hay rulesets a nivel de organización)
- [Aplicación GitHub de Mintlify](/es/deploy/github) instalada en el repositorio
- Uno o más rulesets que apunten a la rama `main` (a nivel de organización o de repositorio)
- Squash merge habilitado en el repositorio
- Uno o más rulesets o reglas de protección de rama que apunten a la rama `main` (a nivel de organización o de repositorio)

## Habilitar squash merge

1. En GitHub, ve a **Settings** -> **General** de tu repositorio.
2. En **Pull Requests**, selecciona **Allow squash merging**.
3. Haz clic en **Save**.

Si squash merge está deshabilitado, automerge no puede completar una fusión incluso cuando todos los bypass de reglas de rama estén configurados correctamente.

<div id="steps">
## Pasos
## Agregar la aplicación GitHub de Mintlify a tus reglas de rama
</div>

Repite estos pasos para cada ruleset que se aplique a tu rama de implementación. Tanto los rulesets **a nivel de organización** como **a nivel de repositorio**.
Expand All @@ -46,9 +62,12 @@ Repite estos pasos para cada ruleset que se aplique a tu rama de implementación
</Step>
</Steps>

Si tu repositorio usa reglas de protección de rama clásicas en lugar de (o además de) rulesets, abre **Settings** -> **Branches**, edita la regla que protege tu rama de implementación y agrega la aplicación GitHub de Mintlify a **Allow specified actors to bypass required pull requests**.

<div id="verify-the-setup">
## Verifica la configuración
</div>

1. **Para colaboradores**: Abre un PR que apunte a `main`. Confirma que aún requiere aprobación y verificaciones de estado exitosas antes de que puedas fusionar.
2. **Para flujos de trabajo**: Activa un flujo de trabajo con automerge habilitado. Confirma que el flujo de trabajo se ejecuta y fusiona exitosamente un PR.
3. **En el panel**: Abre la página de [Workflows](https://dashboard.mintlify.com/products/workflows?tab=workflows) y confirma que el banner de configuración de automerge ya no se muestra.
31 changes: 25 additions & 6 deletions fr/guides/configure-automerge.mdx
Original file line number Diff line number Diff line change
@@ -1,14 +1,21 @@
---
title: "Configurer l'automerge pour les applications GitHub"
sidebarTitle: "Configurer l'automerge"
description: "Configurez des workflows GitHub pour fusionner automatiquement les pull requests Mintlify en ajoutant le bot Mintlify à la liste de contournement du ruleset de votre dépôt."
keywords: ["automerge", "ruleset", "protection de branche", "bypass"]
description: "Configurez la fusion automatique des PR Mintlify en activant le squash merge et en autorisant l'application GitHub Mintlify à contourner les règles."
keywords: ["automerge", "ruleset", "protection de branche", "bypass", "squash merge"]
---

Ajoutez l'application GitHub Mintlify à la liste de contournement d'un ensemble de règles pour que l'application puisse créer et fusionner des pull requests sans que les exigences de révision et de vérification de statut ne la bloquent. Cela vous permet de configurer des [workflows](/workflows/index) pour fusionner automatiquement les modifications dans `main`.
Configurez votre dépôt afin que l'application GitHub Mintlify puisse créer et fusionner des pull requests sans que les exigences de révision et de vérification de statut ne la bloquent. Cela vous permet de configurer des [workflows](/workflows/index) qui fusionnent automatiquement les modifications dans `main`.

L'automerge nécessite deux conditions sur votre dépôt :

1. **La fusion par écrasement (squash merge) est activée.** Mintlify utilise le squash merge pour intégrer les PR.
2. **L'application GitHub Mintlify peut contourner les règles de branche.** Ajoutez l'application à la liste de contournement pour chaque ensemble de règles ou règle de protection de branche classique qui exige des révisions sur votre branche de déploiement.

Le tableau de bord affiche une bannière de configuration de l'automerge sur votre page Workflows si l'une de ces exigences est manquante. Utilisez les liens de la bannière pour accéder directement aux paramètres GitHub à mettre à jour.

<Note>
L'application GitHub Mintlify doit disposer de permissions de contournement sur **tous** les ensembles de règles ciblant votre branche de déploiement, y compris les ensembles de règles définis au niveau de l'organisation et au niveau du dépôt. Si un ensemble de règles ne contient pas l'entrée de contournement, le workflow crée une PR, mais ne la fusionne pas.
L'application GitHub Mintlify doit disposer de permissions de contournement sur **tous** les ensembles de règles et règles de protection de branche ciblant votre branche de déploiement, y compris ceux définis au niveau de l'organisation et au niveau du dépôt. Si une règle ne contient pas l'entrée de contournement, le workflow crée une PR, mais ne la fusionne pas.
</Note>

<div id="prerequisites">
Expand All @@ -17,10 +24,19 @@ Ajoutez l'application GitHub Mintlify à la liste de contournement d'un ensemble

- Accès administrateur au dépôt (et accès administrateur à l'organisation s'il existe des ensembles de règles au niveau de l'organisation)
- [Application GitHub Mintlify](/fr/deploy/github) installée sur le dépôt
- Un ou plusieurs ensembles de règles ciblant la branche `main` (au niveau de l'organisation ou du dépôt)
- Fusion par écrasement (squash merge) activée sur le dépôt
- Un ou plusieurs ensembles de règles ou règles de protection de branche ciblant la branche `main` (au niveau de l'organisation ou du dépôt)

## Activer la fusion par écrasement

1. Sur GitHub, allez dans **Settings** -> **General** de votre dépôt.
2. Sous **Pull Requests**, sélectionnez **Allow squash merging**.
3. Cliquez sur **Save**.

Si la fusion par écrasement est désactivée, l'automerge ne peut pas finaliser une fusion, même si tous les contournements de règles de branche sont correctement configurés.

<div id="steps">
## Étapes
## Ajouter l'application GitHub Mintlify à vos règles de branche
</div>

Répétez ces étapes pour chaque ensemble de règles qui s'applique à votre branche de déploiement. Tant les ensembles de règles **au niveau de l'organisation** que **au niveau du dépôt**.
Expand All @@ -46,9 +62,12 @@ Répétez ces étapes pour chaque ensemble de règles qui s'applique à votre br
</Step>
</Steps>

Si votre dépôt utilise des règles de protection de branche classiques au lieu de (ou en plus de) ensembles de règles, ouvrez **Settings** -> **Branches**, modifiez la règle qui protège votre branche de déploiement, puis ajoutez l'application GitHub Mintlify à **Allow specified actors to bypass required pull requests**.

<div id="verify-the-setup">
## Vérifiez la configuration
</div>

1. **Pour les contributeurs** : Ouvrez une PR ciblant `main`. Confirmez qu'elle nécessite toujours une approbation et des vérifications de statut réussies avant de pouvoir fusionner.
2. **Pour les workflows** : Déclenchez un workflow avec l'automerge activé. Confirmez que le workflow s'exécute et fusionne avec succès une PR.
3. **Dans le tableau de bord** : Ouvrez la page [Workflows](https://dashboard.mintlify.com/products/workflows?tab=workflows) et confirmez que la bannière de configuration de l'automerge ne s'affiche plus.
31 changes: 25 additions & 6 deletions guides/configure-automerge.mdx
Original file line number Diff line number Diff line change
@@ -1,30 +1,46 @@
---
title: "Configure automerge for GitHub Apps"
sidebarTitle: "Configure automerge"
description: "Set up GitHub workflows to automatically merge Mintlify pull requests by adding the Mintlify bot to your repository's ruleset bypass list."
keywords: ["automerge", "ruleset", "branch protection", "bypass"]
description: "Set up GitHub workflows to automatically merge Mintlify pull requests by enabling squash merging and granting the Mintlify GitHub App bypass on branch rules."
keywords: ["automerge", "ruleset", "branch protection", "bypass", "squash merge"]
---

Add the Mintlify GitHub App to a ruleset's bypass list so that the app can create and merge pull requests without review and status check requirements blocking it. This allows you to configure [workflows](/workflows/index) to automatically merge changes to `main`.
Configure your repository so that the Mintlify GitHub App can create and merge pull requests without review and status check requirements blocking it. This allows you to set up [workflows](/workflows/index) that automatically merge changes to `main`.

Automerge requires two things on your repository:

1. **Squash merging is enabled.** Mintlify uses squash merge to land PRs.

Check warning on line 12 in guides/configure-automerge.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/configure-automerge.mdx#L12

In general, use active voice instead of passive voice ('is enabled').
2. **The Mintlify GitHub App can bypass branch rules.** Add the app to the bypass list for every ruleset or classic branch protection rule that requires reviews on your deploy branch.

The dashboard shows an automerge setup banner on your workflows page if either requirement is missing. Use the banner's links to jump directly to the GitHub settings you need to update.

<Note>
The Mintlify GitHub App must have bypass permissions on **every** ruleset that targets your deploy branch, including rulesets defined at the organization level and the repository level. If any ruleset is missing the bypass entry, the workflow creates a PR, but does not merge it.
The Mintlify GitHub App must have bypass permissions on **every** ruleset and branch protection rule that targets your deploy branch, including rules defined at the organization level and the repository level. If any rule is missing the bypass entry, the workflow creates a PR, but does not merge it.
</Note>

## Prerequisites

- Repository admin access (and organization admin access if there are org-level rulesets)
- [Mintlify GitHub App](/deploy/github) installed on the repository
- One or more rulesets targeting the `main` branch (at the org or repo level)
- Squash merging enabled on the repository
- One or more rulesets or branch protection rules targeting the `main` branch (at the org or repo level)

## Enable squash merging

## Steps
1. On GitHub, go to your repository's **Settings** -> **General**.
2. Under **Pull Requests**, select **Allow squash merging**.
3. Click **Save**.

If squash merging is disabled, automerge cannot complete a merge even when all branch rule bypasses are configured correctly.

Check warning on line 34 in guides/configure-automerge.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/configure-automerge.mdx#L34

In general, use active voice instead of passive voice ('is disabled').

Check warning on line 34 in guides/configure-automerge.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/configure-automerge.mdx#L34

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

## Add the Mintlify GitHub App to your branch rules

Repeat these steps for every ruleset that applies to your deploy branch. Both **organization-level** and **repository-level** rulesets.

<Steps>
<Step title="Navigate to rulesets">
- **Repository rulesets**: On GitHub, go to your repository's **Settings** -> **Rules** -> **Rulesets**.

Check warning on line 42 in guides/configure-automerge.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/configure-automerge.mdx#L42

Use 'rulesets?' instead of 'Rulesets'.
- **Organization rulesets**: Go to your organization's **Settings** -> **Rules** -> **Rulesets**.

Check warning on line 43 in guides/configure-automerge.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/configure-automerge.mdx#L43

Use 'rulesets?' instead of 'Rulesets'.
</Step>
<Step title="Select the ruleset">
Click a ruleset that targets your deploy branch, which is usually `main`.
Expand All @@ -42,7 +58,10 @@
</Step>
</Steps>

If your repository uses classic branch protection rules instead of (or in addition to) rulesets, open **Settings** -> **Branches**, edit the rule that protects your deploy branch, and add the Mintlify GitHub App to **Allow specified actors to bypass required pull requests**.

## Verify the setup

1. **For contributors**: Open a PR targeting `main`. Confirm that it still requires approval and passing status checks before you can merge.
2. **For workflows**: Trigger a workflow with automerge enabled. Confirm that the workflow runs and successfully merges a PR.
3. **In the dashboard**: Open the [Workflows](https://dashboard.mintlify.com/products/workflows?tab=workflows) page and confirm that the automerge setup banner is no longer displayed.
31 changes: 25 additions & 6 deletions zh/guides/configure-automerge.mdx
Original file line number Diff line number Diff line change
@@ -1,14 +1,21 @@
---
title: "配置 GitHub 应用的自动合并"
sidebarTitle: "配置自动合并"
description: "通过将 Mintlify 机器人添加到仓库规则集的绕过列表,设置 GitHub 工作流程以自动合并 Mintlify pull request。"
keywords: ["automerge", "ruleset", "分支保护", "bypass"]
description: "通过启用 squash 合并并授予 Mintlify GitHub 应用绕过分支规则的权限,设置 GitHub 工作流程以自动合并 Mintlify pull request。"
keywords: ["automerge", "ruleset", "分支保护", "bypass", "squash merge"]
---

将 Mintlify GitHub 应用添加到规则集的绕过列表中,使该应用能够创建和合并 pull request 而审查和状态检查要求不会阻止它。这允许你配置[工作流程](/workflows/index)以自动将更改合并到 `main`。
配置你的仓库,使 Mintlify GitHub 应用能够创建和合并 pull request 而审查和状态检查要求不会阻止它。这允许你配置[工作流程](/workflows/index)以自动将更改合并到 `main`。

自动合并要求你的仓库满足两个条件:

1. **启用了 squash 合并。** Mintlify 使用 squash 合并来合并 PR。
2. **Mintlify GitHub 应用可以绕过分支规则。** 将该应用添加到每个针对你部署分支并要求审查的规则集或经典分支保护规则的绕过列表中。

如果缺少这两个条件之一,仪表盘会在你的 Workflows 页面上显示自动合并设置横幅。使用横幅中的链接直接跳转到你需要更新的 GitHub 设置。

<Note>
Mintlify GitHub 应用必须对**所有**针对你部署分支的规则集都拥有绕过权限,包括在组织级和仓库级定义的规则集。如果任何规则集缺少绕过条目,工作流程会创建 PR,但不会将其合并。
Mintlify GitHub 应用必须对**所有**针对你部署分支的规则集和分支保护规则都拥有绕过权限,包括在组织级和仓库级定义的规则。如果任何规则缺少绕过条目,工作流程会创建 PR,但不会将其合并。
</Note>

<div id="prerequisites">
Expand All @@ -17,10 +24,19 @@ keywords: ["automerge", "ruleset", "分支保护", "bypass"]

- 仓库管理员权限(如果有组织级规则集,还需要组织管理员权限)
- 在仓库中安装了 [Mintlify GitHub 应用](/zh/deploy/github)
- 一个或多个针对 `main` 分支的规则集(在组织级或仓库级)
- 在仓库中启用了 squash 合并
- 一个或多个针对 `main` 分支的规则集或分支保护规则(在组织级或仓库级)

## 启用 squash 合并

1. 在 GitHub 上,进入仓库的 **Settings** -> **General**。
2. 在 **Pull Requests** 下,选择 **Allow squash merging**。
3. 点击 **Save**。

如果 squash 合并被禁用,即使所有分支规则的绕过配置都正确,自动合并也无法完成合并。

<div id="steps">
## 步骤
## 将 Mintlify GitHub 应用添加到你的分支规则
</div>

对适用于你部署分支的每个规则集重复以下步骤。包括**组织级**和**仓库级**的规则集。
Expand All @@ -46,9 +62,12 @@ keywords: ["automerge", "ruleset", "分支保护", "bypass"]
</Step>
</Steps>

如果你的仓库使用经典分支保护规则(而不是规则集,或者除了规则集之外还使用),请打开 **Settings** -> **Branches**,编辑保护你部署分支的规则,并将 Mintlify GitHub 应用添加到 **Allow specified actors to bypass required pull requests**。

<div id="verify-the-setup">
## 验证设置
</div>

1. **对于贡献者**:打开一个针对 `main` 的 PR。确认它仍然需要批准和通过状态检查后你才能合并。
2. **对于工作流程**:触发启用了自动合并的工作流程。确认工作流程运行并成功合并 PR。
3. **在仪表盘中**:打开 [Workflows](https://dashboard.mintlify.com/products/workflows?tab=workflows) 页面,确认自动合并设置横幅不再显示。
Loading