# General Translation Platform: 配置 Locadex 自动化
URL: https://generaltranslation.com/zh/docs/platform/locadex/guides/configuring-automations.mdx
---

title: 配置 Locadex 自动化
description: "如何配置 Locadex 自动化：本指南介绍模板、触发器、分支、拉取请求行为和命令。"
related:
  links:
    - /docs/platform/locadex/guides/auto-merging-prs
    - /docs/platform/locadex/guides/managing-languages
    - /docs/platform/locadex/guides/viewing-automation-activity
    - /docs/platform/locadex/guides/adding-environment-variables

---

使用自动化设置来控制 Locadex 更改哪些内容、何时运行，以及如何创建或更新拉取请求。

Locadex 有三种模板。每个自动化都可以在拉取请求发生变更时、有提交被推送时，或手动运行。

## 选择模板 [#choose-template]

打开 **项目 > Automations**。在 **Start with a template** 下，选择：

* 用于代码国际化的 **Generate code**。
  * 设置 Locadex 何时使用 `t()` 或 `T` 组件等国际化库调用来包装源代码。
* 用于内容更新的 **Generate translations and push**。
  * 设置 Locadex 何时将新增或更新的源内容翻译成目标语言。
* 用于区域设置更新的 **Keep locales in sync**。
  * 设置当添加或移除语言时，Locadex 何时更新你项目中的文件。手动运行时，你可以选择源区域设置和目标区域设置。

在此页面中选择一个已配置的自动化进行编辑。你也可以使用 **组织 > Locadex > Automations** 跨项目搜索和管理自动化。

## 配置自动化 [#configure-automation]

### 编辑触发器

将 **Run when** 设置为以下三种触发器之一：

* **A pull request changes** 会在相关拉取请求被打开、重新打开或标记为 **可供审校** 时运行。新的提交会取消任何正在进行中的运行，但不会启动新的运行；当拉取请求再次准备好处理时，请在评论中输入 `/locadex`。
* **A commit is pushed** 会在有提交被推送到目标分支时运行。
* **Started manually** 仅会在你点击 **Run now** 时运行。

新的 **Generate code** 和 **Generate translations and push** 自动化默认使用 **A pull request changes**。**Keep locales in sync** 默认使用 **Started manually**。

### 编辑目标分支和前缀

将 **Target branch** 设置为 Locadex 应监控变更的分支。大多数项目使用 `main`。

为 Locadex 创建的分支设置 **Created branch prefix**。默认值为：

```txt
locadex/
```

使用稳定的前缀，以便在 GitHub 上更容易找到 Locadex 分支。

### 编辑 PR 设置

使用这些开关来控制 Locadex 如何创建和管理拉取请求：

* **自动合并** 会在检查通过后自动合并 Locadex 拉取请求。请参阅 [自动合并 Locadex PR](/docs/platform/locadex/guides/auto-merging-prs)。
* **仅限已更改文件** 会将 **Generate code** 相关性检查限制为仅检查变更行，而不是已修改文件的全部内容。翻译和区域设置同步自动化不会使用此过滤条件，文档框架也会跳过相关性检查。
* **保留本地编辑** 会保留对 Locadex 先前生成文件所做的手动修改。

对于自动触发的任务，Locadex 会为相同分支 和自动化复用同一个未关闭的拉取请求。在执行增量更新前，它会先将可复用的 PR 标记为草稿，并发布一条按次 run 的状态评论。只有当该 PR 在本次 run 前已处于可供审校状态时，它才会将其恢复为可供审校；如果是用户手动保留为草稿，则会继续保持草稿状态。通过仪表板手动运行的任务会使用一次性的拉取请求。

对于由拉取请求触发的自动化，Locadex 在创建单独的 Locadex PR 时，会在触发它的 PR 中添加一条评论，并附上该 Locadex PR 的链接。

页面底部的文本框提供了额外的自定义选项：

* **拉取请求标题** 用于设置 Locadex 拉取请求的标题。
* **拉取请求描述** 用于设置拉取请求正文。
* **提交消息** 用于设置 Locadex 提交使用的消息。

### 添加命令

使用命令可在你的项目中运行 setup、验证等步骤。你还可以使用命令来安装依赖、构建项目、检查生成的变更，或运行项目特定的检查。命令可以在 Locadex 处理文件之前或之后运行：

* **预处理命令** 会在 Locadex 处理文件之前运行。例如，运行 `npm run build`。
* **后处理命令** 会在 Locadex 处理文件之后运行。例如，运行 `npm run typecheck`。

命令会从代码仓库根目录运行，并在 [Locadex VM image](/docs/platform/locadex/reference/vm-image) 中执行。如果某个自动化因缺少包、脚本或二进制文件而失败，请添加预处理命令。

如果任一检查失败，[自动合并](/docs/platform/locadex/guides/auto-merging-prs) 就不会运行。
## Next steps

- /docs/platform/locadex/guides/auto-merging-prs
- /docs/platform/locadex/guides/managing-languages
- /docs/platform/locadex/guides/viewing-automation-activity
- /docs/platform/locadex/guides/adding-environment-variables