@intlayer/docs 5.7.7 → 5.7.8

package/docs/ru/CI_CD.md

@@ -1,8 +1,8 @@
 ---
 createdAt: 2025-05-20
-updatedAt: 2025-06-29
+updatedAt: 2025-08-13
 title: Интеграция CI/CD
-description: Узнайте, как интегрировать Intlayer в ваш CI/CD процесс для автоматизированного управления контентом и развертывания.
+description: Узнайте, как интегрировать Intlayer в ваш CI/CD конвейер для автоматизированного управления контентом и развертывания.
 keywords:
   - CI/CD
   - Непрерывная интеграция
@@ -17,13 +17,13 @@ slugs:
   - ci-cd
 ---
 
-# Автоматическая генерация переводов в CI/CD процессе
+# Автоматическая генерация переводов в CI/CD конвейере
 
 Intlayer позволяет автоматически генерировать переводы для ваших файлов декларации контента. Существует несколько способов достичь этого в зависимости от вашего рабочего процесса.
 
 ## Использование CMS
 
-С Intlayer вы можете использовать рабочий процесс, при котором локально объявляется только один язык, а все переводы управляются удаленно через CMS. Это позволяет полностью отделить контент и переводы от кодовой базы, обеспечивая большую гибкость для редакторов контента и позволяя горячую перезагрузку контента (нет необходимости пересобирать приложение для применения изменений).
+С Intlayer вы можете использовать рабочий процесс, при котором локально объявляется только одна локаль, а все переводы управляются удаленно через CMS. Это позволяет полностью отделить контент и переводы от кодовой базы, обеспечивая большую гибкость для редакторов контента и позволяя горячую перезагрузку контента (нет необходимости пересобирать приложение для применения изменений).
 
 ### Пример конфигурации
 
@@ -33,7 +33,7 @@ import { Locales, type IntlayerConfig } from "intlayer";
 const config: IntlayerConfig = {
   internationalization: {
     locales: [Locales.ENGLISH, Locales.SPANISH, Locales.FRENCH],
-    requiredLocales: [Locales.ENGLISH], // Необязательные языки будут управляться удаленно
+    requiredLocales: [Locales.ENGLISH], // Необязательные локали будут управляться удаленно
     defaultLocale: Locales.ENGLISH,
   },
   editor: {
@@ -45,7 +45,7 @@ const config: IntlayerConfig = {
     clientSecret: process.env.INTLAYER_CLIENT_SECRET,
   },
   ai: {
-    applicationContext: "Это тестовое приложение", // Помогает обеспечить согласованность генерации перевода
+    applicationContext: "This is a test application", // Помогает обеспечить согласованное создание переводов
   },
 };
 
@@ -66,7 +66,7 @@ import { Locales, type IntlayerConfig } from "intlayer";
 const config: IntlayerConfig = {
   internationalization: {
     locales: [Locales.ENGLISH, Locales.SPANISH, Locales.FRENCH],
-    requiredLocales: [Locales.ENGLISH], // Необязательные локали обрабатываются удаленно
+    requiredLocales: [Locales.ENGLISH], // Необязательные локали обрабатываются удалённо
     defaultLocale: Locales.ENGLISH,
   },
   editor: {
@@ -75,9 +75,9 @@ const config: IntlayerConfig = {
   },
   ai: {
     provider: "openai",
-    apiKey: process.env.OPENAI_API_KEY, // Используйте свой собственный API ключ
+    apiKey: process.env.OPENAI_API_KEY, // Используйте свой собственный API-ключ
 
-    applicationContext: "Это тестовое приложение", // Помогает обеспечить согласованность генерации перевода
+    applicationContext: "This is a test application", // Помогает обеспечить согласованное создание переводов
   },
 };
 
@@ -85,11 +85,11 @@ export default config;
 ```
 
 ```bash fileName=".husky/pre-push"
-npx intlayer build                          # Чтобы убедиться, что словари обновлены
+npx intlayer build                          # Чтобы словари были актуальными
 npx intlayer fill --unpushed --mode fill    # Заполняет только отсутствующий контент, не обновляет существующий
 ```
 
-> Для получения дополнительной информации о командах Intlayer CLI и их использовании, обратитесь к [документации CLI](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/intlayer_cli.md).
+> Для получения дополнительной информации о командах Intlayer CLI и их использовании обратитесь к [документации CLI](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/intlayer_cli.md).
 
 > Если у вас несколько приложений в репозитории, использующих отдельные экземпляры intlayer, вы можете использовать аргумент `--base-dir` следующим образом:
 
@@ -108,65 +108,91 @@ npx intlayer fill --base-dir ./app2 --unpushed --mode fill
 Intlayer предоставляет команду CLI для автоматического заполнения и проверки содержимого словаря. Это можно интегрировать в ваш CI/CD процесс с использованием GitHub Actions.
 
 ```yaml fileName=".github/workflows/intlayer-translate.yml"
-name: Intlayer Auto-Fill
+name: Intlayer Автозаполнение
+# Условия запуска этого workflow
 on:
-  push:
-    branches: [ main ]
-    paths:
-      - 'src/**'
   pull_request:
-    branches: [ main ]
-    paths:
-      - 'src/**'
-  workflow_dispatch: {}
+    branches:
+      - "main"
+
+permissions:
+  contents: write
+  pull-requests: write
 
 concurrency:
-  group: 'autofill-${{ github.ref }}'
+  group: "autofill-${{ github.ref }}"
   cancel-in-progress: true
 
 jobs:
   autofill:
     runs-on: ubuntu-latest
     env:
-      INTLAYER_CLIENT_ID: ${{ secrets.INTLAYER_CLIENT_ID }}
-      INTLAYER_CLIENT_SECRET: ${{ secrets.INTLAYER_CLIENT_SECRET }}
-      OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+      # OpenAI
+      AI_MODEL: openai
+      AI_PROVIDER: gpt-5-mini
+      AI_API_KEY: ${{ secrets.AI_API_KEY }}
 
     steps:
-      - name: ⬇️ Клонировать репозиторий
-        uses: actions/checkout@v3
+      # Шаг 1: Получить последний код из репозитория
+      - name: ⬇️ Проверка репозитория
+        uses: actions/checkout@v4
         with:
-          persist-credentials: true
+          persist-credentials: true # Сохранять учетные данные для создания PR
+          fetch-depth: 0 # Получить полную историю git для анализа изменений
 
-      - name: 🟢 Установить Node.js
-        uses: actions/setup-node@v3
+      # Шаг 2: Настроить окружение Node.js
+      - name: 🟢 Настроить Node.js
+        uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: 20 # Использовать Node.js 20 LTS для стабильности
 
+      # Шаг 3: Установить зависимости проекта
       - name: 📦 Установить зависимости
-        run: npm ci
+        run: npm install
+
+      # Шаг 4: Глобально установить Intlayer CLI для управления переводами
+      - name: 📦 Установить Intlayer
+        run: npm install -g intlayer-cli
 
+      # Шаг 5: Собрать проект Intlayer для генерации файлов перевода
       - name: ⚙️ Собрать проект Intlayer
         run: npx intlayer build
 
-      - name: 🤖 Автоматически заполнить отсутствующие переводы
-        run: npx intlayer fill --git-diff --mode fill
-
-      - name: 📤 Создать или обновить PR с переводами
-        uses: peter-evans/create-pull-request@v4
-        with:
-          commit-message: chore: авто-заполнение отсутствующих переводов [skip ci]
-          branch: auto-translations
-          title: chore: обновить отсутствующие переводы
-          labels: translation, automated
+      # Шаг 6: Использовать ИИ для автоматического заполнения отсутствующих переводов
+      - name: 🤖 Автоматическое заполнение отсутствующих переводов
+        run: npx intlayer fill --git-diff --mode fill --provider $AI_PROVIDER --model $AI_MODEL --api-key $AI_API_KEY
+
+      # Шаг 7: Проверить наличие изменений и зафиксировать их
+      - name: � Проверить изменения
+        id: check-changes
+        run: |
+          if [ -n "$(git status --porcelain)" ]; then
+            echo "has-changes=true" >> $GITHUB_OUTPUT
+          else
+            echo "has-changes=false" >> $GITHUB_OUTPUT
+          fi
+
+      # Шаг 8: Зафиксировать и отправить изменения, если они есть
+      - name: 📤 Зафиксировать и отправить изменения
+        if: steps.check-changes.outputs.has-changes == 'true'
+        run: |
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Action"
+          git add .
+          git commit -m "chore: автоматическое заполнение отсутствующих переводов [skip ci]"
+          git push origin HEAD:${{ github.head_ref }}
 ```
 
+Чтобы настроить переменные окружения, перейдите в GitHub → Settings → Secrets and variables → Actions и добавьте секрет .
+
 > Аналогично Husky, в случае монорепозитория вы можете использовать аргумент `--base-dir` для последовательной обработки каждого приложения.
 
-> По умолчанию аргумент `--git-diff` фильтрует словари, которые включают изменения от базы (по умолчанию `origin/main`) до текущей ветки (по умолчанию: `HEAD`).
+> По умолчанию аргумент `--git-diff` фильтрует словари, которые содержат изменения от базы (по умолчанию `origin/main`) до текущей ветки (по умолчанию: `HEAD`).
 
 > Для получения дополнительной информации о командах Intlayer CLI и их использовании обратитесь к [документации CLI](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/intlayer_cli.md).
 
-## История документа
+## История документации
 
-- 5.5.10 - 2025-06-29: Инициализация истории
+| Версия | Дата       | Изменения             |
+| ------ | ---------- | --------------------- |
+| 5.5.10 | 2025-06-29 | Инициализация истории |

package/docs/zh/CI_CD.md

@@ -1,6 +1,6 @@
 ---
 createdAt: 2025-05-20
-updatedAt: 2025-06-29
+updatedAt: 2025-08-13
 title: CI/CD 集成
 description: 了解如何将 Intlayer 集成到您的 CI/CD 流水线中，实现内容管理和部署的自动化。
 keywords:
@@ -19,11 +19,11 @@ slugs:
 
 # 在 CI/CD 流水线中自动生成翻译
 
-Intlayer 允许自动生成内容声明文件的翻译。根据您的工作流程，有多种实现方式。
+Intlayer 允许自动生成内容声明文件的翻译。根据您的工作流程，有多种方式可以实现这一点。
 
 ## 使用 CMS
 
-使用 Intlayer，您可以采用一种工作流程，其中本地只声明单一语言环境，而所有翻译内容均通过 CMS 远程管理。这使得内容和翻译可以完全脱离代码库，提供给内容编辑者更大的灵活性，并支持热内容重载（无需重新构建应用即可应用更改）。
+使用 Intlayer，您可以采用一种工作流程，只在本地声明单一语言环境，而所有翻译内容则通过 CMS 远程管理。这使内容和翻译完全脱离代码库，为内容编辑者提供更大的灵活性，并支持热内容重载（无需重建应用即可应用更改）。
 
 ### 示例配置
 
@@ -45,7 +45,7 @@ const config: IntlayerConfig = {
     clientSecret: process.env.INTLAYER_CLIENT_SECRET,
   },
   ai: {
-    applicationContext: "This is a test application", // 有助于确保一致的翻译生成
+    applicationContext: "这是一个测试应用程序", // 有助于确保一致的翻译生成
   },
 };
 
@@ -77,7 +77,7 @@ const config: IntlayerConfig = {
     provider: "openai",
     apiKey: process.env.OPENAI_API_KEY, // 使用您自己的 API 密钥
 
-    applicationContext: "这是一个测试应用", // 有助于确保翻译生成的一致性
+    applicationContext: "这是一个测试应用程序", // 有助于确保翻译生成的一致性
   },
 };
 
@@ -85,7 +85,7 @@ export default config;
 ```
 
 ```bash fileName=".husky/pre-push"
-npx intlayer build                          # 确保字典是最新的
+npx intlayer build                          # 确保词典是最新的
 npx intlayer fill --unpushed --mode fill    # 仅填充缺失内容，不更新已有内容
 ```
 
@@ -105,68 +105,94 @@ npx intlayer fill --base-dir ./app2 --unpushed --mode fill
 
 ## 使用 GitHub Actions
 
-Intlayer 提供了一个 CLI 命令用于自动填充和审查字典内容。您可以使用 GitHub Actions 将其集成到您的 CI/CD 工作流中。
+Intlayer 提供了一个 CLI 命令，用于自动填充和审查词典内容。您可以将其集成到使用 GitHub Actions 的 CI/CD 工作流中。
 
 ```yaml fileName=".github/workflows/intlayer-translate.yml"
 name: Intlayer 自动填充
+# 触发此工作流的条件
 on:
-  push:
-    branches: [ main ]
-    paths:
-      - 'src/**'
   pull_request:
-    branches: [ main ]
-    paths:
-      - 'src/**'
-  workflow_dispatch: {}
+    branches:
+      - "main"
+
+permissions:
+  contents: write
+  pull-requests: write
 
 concurrency:
-  group: 'autofill-${{ github.ref }}'
+  group: "autofill-${{ github.ref }}"
   cancel-in-progress: true
 
 jobs:
   autofill:
     runs-on: ubuntu-latest
     env:
-      INTLAYER_CLIENT_ID: ${{ secrets.INTLAYER_CLIENT_ID }}
-      INTLAYER_CLIENT_SECRET: ${{ secrets.INTLAYER_CLIENT_SECRET }}
-      OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+      # OpenAI
+      AI_MODEL: openai
+      AI_PROVIDER: gpt-5-mini
+      AI_API_KEY: ${{ secrets.AI_API_KEY }}
 
     steps:
+      # 第一步：从仓库获取最新代码
       - name: ⬇️ 签出仓库
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
-          persist-credentials: true
+          persist-credentials: true # 保留凭据以创建拉取请求
+          fetch-depth: 0 # 获取完整的 git 历史以进行差异分析
 
+      # 步骤 2：设置 Node.js 环境
       - name: 🟢 设置 Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: 20 # 使用 Node.js 20 LTS 以保证稳定性
 
+      # 步骤 3：安装项目依赖
       - name: 📦 安装依赖
-        run: npm ci
+        run: npm install
+
+      # 步骤 4：全局安装 Intlayer CLI 以管理翻译
+      - name: 📦 安装 Intlayer
+        run: npm install -g intlayer-cli
 
+      # 步骤 5：构建 Intlayer 项目以生成翻译文件
       - name: ⚙️ 构建 Intlayer 项目
         run: npx intlayer build
 
+      # 步骤 6：使用 AI 自动填充缺失的翻译
       - name: 🤖 自动填充缺失的翻译
-        run: npx intlayer fill --git-diff --mode fill
-
-      - name: 📤 创建或更新翻译拉取请求
-        uses: peter-evans/create-pull-request@v4
-        with:
-          commit-message: chore: 自动填充缺失的翻译 [skip ci]
-          branch: auto-translations
-          title: chore: 更新缺失的翻译
-          labels: translation, automated
+        run: npx intlayer fill --git-diff --mode fill --provider $AI_PROVIDER --model $AI_MODEL --api-key $AI_API_KEY
+
+      # 第7步：检查是否有更改并提交
+      - name: � 检查更改
+        id: check-changes
+        run: |
+          if [ -n "$(git status --porcelain)" ]; then
+            echo "has-changes=true" >> $GITHUB_OUTPUT
+          else
+            echo "has-changes=false" >> $GITHUB_OUTPUT
+          fi
+
+      # 第8步：如果存在更改，则提交并推送
+      - name: 📤 提交并推送更改
+        if: steps.check-changes.outputs.has-changes == 'true'
+        run: |
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Action"
+          git add .
+          git commit -m "chore: 自动填充缺失的翻译 [skip ci]"
+          git push origin HEAD:${{ github.head_ref }}
 ```
 
-> 与 Husky 相同，在 monorepo 的情况下，您可以使用 `--base-dir` 参数来顺序处理每个应用。
+要设置环境变量，请前往 GitHub → 设置 → Secrets and variables → Actions 并添加密钥（API_KEY）。
+
+> 与 Husky 相同，在单一仓库（monorepo）的情况下，可以使用 `--base-dir` 参数依次处理每个应用。
 
-> 默认情况下，`--git-diff` 参数会过滤包含从基线（默认 `origin/main`）到当前分支（默认：`HEAD`）的更改的字典。
+> 默认情况下，`--git-diff` 参数会筛选包含从基线（默认 `origin/main`）到当前分支（默认 `HEAD`）的更改的字典。
 
 > 有关 Intlayer CLI 命令及其用法的更多信息，请参阅 [CLI 文档](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/intlayer_cli.md)。
 
 ## 文档历史
 
-- 5.5.10 - 2025-06-29：初始化历史
+| 版本   | 日期       | 变更           |
+| ------ | ---------- | -------------- |
+| 5.5.10 | 2025-06-29 | 初始化历史记录 |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intlayer/docs",
-  "version": "5.7.7",
+  "version": "5.7.8",
   "private": false,
   "description": "Intlayer documentation",
   "keywords": [
@@ -49,8 +49,8 @@
     "legal"
   ],
   "dependencies": {
-    "@intlayer/config": "5.7.7",
-    "intlayer": "5.7.7"
+    "@intlayer/config": "5.7.8",
+    "intlayer": "5.7.8"
   },
   "devDependencies": {
     "@types/node": "^22.15.30",
@@ -65,16 +65,16 @@
     "tsx": "^4.19.4",
     "typescript": "^5.8.3",
     "vitest": "^3.2.2",
-    "@intlayer/api": "5.7.7",
-    "@intlayer/cli": "5.7.7",
+    "@intlayer/api": "5.7.8",
+    "@intlayer/cli": "5.7.8",
     "@utils/ts-config": "1.0.4",
     "@utils/ts-config-types": "1.0.4",
     "@utils/tsup-config": "1.0.4"
   },
   "peerDependencies": {
-    "@intlayer/api": "5.7.7",
-    "@intlayer/cli": "5.7.7",
-    "@intlayer/config": "5.7.7"
+    "@intlayer/api": "5.7.8",
+    "@intlayer/cli": "5.7.8",
+    "@intlayer/config": "5.7.8"
   },
   "engines": {
     "node": ">=14.18"