Skip to content
Open
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
13 changes: 13 additions & 0 deletions es/guides/configure-automerge.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ 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
- Squash merging habilitado en el repositorio (**Settings** -> **General** -> **Pull Requests** -> **Allow squash merging**)
- Uno o más rulesets que apunten a la rama `main` (a nivel de organización o de repositorio)

<div id="steps">
Expand Down Expand Up @@ -52,3 +53,15 @@ Repite estos pasos para cada ruleset que se aplique a tu rama de implementación

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.

<div id="troubleshoot-automerge">
## Solución de problemas de automerge
</div>

Si tu configuración de automerge está incompleta, la página [Workflows](https://dashboard.mintlify.com/products/workflows?tab=workflows) de tu panel muestra un aviso encima de la lista de flujos de trabajo con un enlace a los ajustes de GitHub que debes actualizar. El aviso aparece por cualquiera de los siguientes motivos:

- **Squash merging está deshabilitado**: Habilita **Allow squash merging** en los ajustes de pull requests de tu repositorio para que Mintlify pueda fusionar los PRs de los flujos de trabajo con automerge.
- **Las reglas de rama necesitan un bypass para Mintlify**: Agrega la aplicación GitHub de Mintlify a la lista de bypass de cada ruleset que apunte a tu rama de implementación, siguiendo los pasos anteriores.
- **Una ejecución anterior de automerge no se pudo aceptar**: Revisa la última ejecución fallida, corrige la configuración de GitHub correspondiente y vuelve a ejecutar el flujo de trabajo.

Haz clic en **Set up on GitHub** en el aviso para ir directamente a la página de ajustes correspondiente. Puedes descartar el aviso una vez que hayas resuelto el problema.
13 changes: 13 additions & 0 deletions fr/guides/configure-automerge.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ 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
- Squash merging activé sur le dépôt (**Settings** -> **General** -> **Pull Requests** -> **Allow squash merging**)
- Un ou plusieurs ensembles de règles ciblant la branche `main` (au niveau de l'organisation ou du dépôt)

<div id="steps">
Expand Down Expand Up @@ -52,3 +53,15 @@ Répétez ces étapes pour chaque ensemble de règles qui s'applique à votre br

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.

<div id="troubleshoot-automerge">
## Dépannage de l'automerge
</div>

Si votre configuration d'automerge est incomplète, la page [Workflows](https://dashboard.mintlify.com/products/workflows?tab=workflows) de votre tableau de bord affiche un avertissement au-dessus de la liste des workflows avec un lien vers les paramètres GitHub que vous devez mettre à jour. L'avertissement apparaît pour l'une des raisons suivantes :

- **Le squash merging est désactivé** : Activez **Allow squash merging** dans les paramètres de pull request de votre dépôt afin que Mintlify puisse fusionner les PRs des workflows avec automerge.
- **Les règles de branche nécessitent un contournement pour Mintlify** : Ajoutez l'application GitHub Mintlify à la liste de contournement de chaque ensemble de règles ciblant votre branche de déploiement, en suivant les étapes ci-dessus.
- **Une exécution précédente d'automerge n'a pas pu être acceptée** : Examinez la dernière exécution en échec, corrigez la configuration GitHub correspondante, puis relancez le workflow.

Cliquez sur **Set up on GitHub** dans l'avertissement pour accéder directement à la page de paramètres concernée. Vous pouvez fermer l'avertissement une fois le problème résolu.
11 changes: 11 additions & 0 deletions guides/configure-automerge.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@

- Repository admin access (and organization admin access if there are org-level rulesets)
- [Mintlify GitHub App](/deploy/github) installed on the repository
- Squash merging enabled on the repository (**Settings** -> **General** -> **Pull Requests** -> **Allow squash merging**)
- One or more rulesets targeting the `main` branch (at the org or repo level)

## Steps
Expand All @@ -23,8 +24,8 @@

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

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/configure-automerge.mdx#L27

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

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/configure-automerge.mdx#L28

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 @@ -46,3 +47,13 @@

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.

## Troubleshoot automerge

If your automerge setup is incomplete, the [Workflows](https://dashboard.mintlify.com/products/workflows?tab=workflows) page in your dashboard shows a warning banner above the workflow list with a link to the GitHub settings you need to update. The banner appears for any of the following reasons:

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/configure-automerge.mdx#L53

Use 'preceding' instead of 'above'.

- **Squash merging is disabled**: Enable **Allow squash merging** in your repository's pull request settings so Mintlify can merge automerge workflow PRs.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/configure-automerge.mdx#L55

In general, use active voice instead of passive voice ('is disabled').
- **Branch rules need a Mintlify bypass**: Add the Mintlify GitHub App to the bypass list on every ruleset targeting your deploy branch, following the steps above.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/configure-automerge.mdx#L56

Use 'preceding' instead of 'above'.
- **A previous automerge run could not be accepted**: Review the most recent failed run, fix the underlying GitHub configuration, then re-run the workflow.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/configure-automerge.mdx#L57

In general, use active voice instead of passive voice ('be accepted').

Click **Set up on GitHub** in the banner to jump directly to the relevant settings page. You can dismiss the banner once you've resolved the issue.
13 changes: 13 additions & 0 deletions zh/guides/configure-automerge.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ keywords: ["automerge", "ruleset", "分支保护", "bypass"]

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

<div id="steps">
Expand Down Expand Up @@ -52,3 +53,15 @@ keywords: ["automerge", "ruleset", "分支保护", "bypass"]

1. **对于贡献者**:打开一个针对 `main` 的 PR。确认它仍然需要批准和通过状态检查后你才能合并。
2. **对于工作流程**:触发启用了自动合并的工作流程。确认工作流程运行并成功合并 PR。

<div id="troubleshoot-automerge">
## 自动合并故障排查
</div>

如果你的自动合并配置不完整,控制台的 [Workflows](https://dashboard.mintlify.com/products/workflows?tab=workflows) 页面会在工作流程列表上方显示警告横幅,并附带跳转到需要更新的 GitHub 设置的链接。横幅在以下任一情况下出现:

- **Squash 合并被禁用**:在仓库的 pull request 设置中启用 **Allow squash merging**,以便 Mintlify 能够合并自动合并工作流程的 PR。
- **分支规则需要为 Mintlify 添加绕过**:按照上述步骤,将 Mintlify GitHub 应用添加到每个针对你部署分支的规则集的绕过列表中。
- **之前的自动合并运行无法被接受**:检查最近一次失败的运行,修复相关的 GitHub 配置,然后重新运行该工作流程。

点击横幅中的 **Set up on GitHub**,可直接跳转到相关的设置页面。问题解决后,你可以关闭该横幅。
Loading