https://github.com/pelikhan/action-continuous-translation
Automatically maintains translation of markdown files using GenAI.
https://github.com/pelikhan/action-continuous-translation
actions astro continuous-ai documentation genai llms markdown starlight starlight-astro translations
Last synced: 5 months ago
JSON representation
Automatically maintains translation of markdown files using GenAI.
- Host: GitHub
- URL: https://github.com/pelikhan/action-continuous-translation
- Owner: pelikhan
- License: mit
- Created: 2025-07-03T13:36:03.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-07-10T12:07:38.000Z (5 months ago)
- Last Synced: 2025-07-10T15:04:46.773Z (5 months ago)
- Topics: actions, astro, continuous-ai, documentation, genai, llms, markdown, starlight, starlight-astro, translations
- Language: TypeScript
- Homepage: https://pelikhan.github.io/action-continuous-translation/
- Size: 3.46 MB
- Stars: 7
- Watchers: 0
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.es.md
- License: LICENSE
Awesome Lists containing this project
- awesome-continuous-ai - action-continuous-translation - custom GitHub Action to maintain a translation of markdown files (Categories / Continuous Documentation)
README
# 🌍 Traducción Continua
> **Traduce automáticamente tu documentación en markdown utilizando IA** - impulsado por [GitHub Actions](https://github.com/actions) y [GitHub Models](https://github.com/models) con soporte integrado para [Astro Starlight](https://starlight.astro.build/)!
[](https://github.com/marketplace/actions/continuous-translation)
[](https://pelikhan.github.io/action-continuous-translation/)
## ✨ Funciones
* 🚀 **Traducción Incremental** - Sólo traduce el contenido modificado, ahorrando tiempo y costos de API
* 🎯 **Análisis AST Inteligente** - Preserva la estructura y el formato del markdown
* 🔄 **Gestión de Caché** - Caché inteligente para evitar traducciones redundantes
* 📚 **Listo para Astro Starlight** - Soporte integrado para sitios de documentación
* 🌐 **Soporte Multilenguaje** - Traduce a múltiples idiomas simultáneamente
* 🔍 **Validación de Calidad** - Validación automática de la calidad de la traducción
* ⚡ **Nativo en GitHub Actions** - Integración fluida con tu tubería CI/CD
* 🤖 **Impulsado por IA** - Aprovecha GitHub Models para traducciones fluidas y de alta calidad
## 📚 Recursos
* 📖 [**Documentación**](https://pelikhan.github.io/action-continuous-translation/) - Guía completa de configuración y referencia de API (también traducida por esta acción - ve el [tablero de traducción](https://pelikhan.github.io/action-continuous-translation/dashboard/))
* ✍️ [**Publicación del Blog**](https://microsoft.github.io/genaiscript/blog/continuous-translations/) - Análisis profundo de la tecnología
* 🌐 **Traducciones**: [Inglés](./README.md) | [Francés](./README.fr.md) | [Español](./README.es.md) | [Portugués (Brasil)](./README.pt-br.md) | [العربية](./README.ar.md)
## 🔧 Cómo Funciona
Esta acción utiliza [GenAIScript](https://microsoft.github.io/genaiscript/) para analizar y traducir inteligentemente tus documentos en markdown. Aquí está la magia detrás de escena:
1. **📄 Parsear** - Convierte markdown a AST (Árbol de Sintaxis Abstracta)
2. **🔍 Analizar** - Identifica el contenido que necesita traducirse frente a las traducciones existentes
3. **🤖 Traducir** - Usa IA para generar traducciones de alta calidad
4. **✅ Validar** - Asegura la calidad de la traducción e inyecta en el documento
5. **💾 Caché** - Guarda las traducciones para futuras actualizaciones incrementales
6. **📝 Commit** - Realiza commits automáticos de los cambios en tu repositorio
## ⚙️ Configuración
### 📝 Configuración Básica
| Parámetro | Descripción | Por defecto |
| ------------------- | ---------------------------------------------------------------------- | ---------------------------------------------- |
| `lang` | Idiomas objetivo para la traducción (códigos ISO, separados por comas) | `fr` |
| `source` | Idioma de origen (código ISO) | `en` |
| `files` | Archivos a traducir (separados por punto y coma) | `README.md` |
| `instructions` | Instrucciones personalizadas para la traducción | - |
| `instructions_file` | Ruta al archivo con instrucciones de traducción | - |
| `glossary_file` | Ruta al archivo con términos del glosario | - |
| `translations_dir` | Carpeta para almacenar las traducciones | `translations` |
| `filename_template` | Plantilla Jinja para generar la ruta de archivo traducida | `{{dirname}}/{{basename}}.{{lang}}{{extname}}` |
### 🌟 Integración con Astro Starlight
| Parámetro | Descripción | Requerido |
| ---------------- | --------------------------------------------------- | ------------------- |
| `starlight_dir` | Carpeta raíz de la documentación de Astro Starlight | Sólo para Starlight |
| `starlight_base` | Alias base para la documentación de Starlight | Opcional |
### 🔧 Diagnósticos y Depuración
| Parámetro | Descripción | Por defecto |
| --------- | ------------------------------------------------------------------------------------------------------------------- | ----------- |
| `force` | Forzar la traducción incluso si ya está traducido | `false` |
| `debug` | Habilitar registro de depuración[aprender más](https://microsoft.github.io/genaiscript/reference/scripts/logging/)) | `false` |
### 🤖 Configuración del Proveedor de IA
#### Modelos de GitHub (Recomendado)
| Parámetro | Descripción | Por defecto |
| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |
| `github_token` | Token de GitHub con permiso `models: read`permiso (guía de configuración)[guía de configuración](https://microsoft.github.io/genaiscript/reference/github-actions/#github-models-permissions)) | `${{ secrets.GITHUB_TOKEN }}` |
#### OpenAI
| Parámetro | Descripción | Por defecto |
| ----------------- | ------------------------- | ------------------------------- |
| `openai_api_key` | Clave de API de OpenAI | `${{ secrets.OPENAI_API_KEY }}` |
| `openai_api_base` | URL base de API de OpenAI | `${{ env.OPENAI_API_BASE }}` |
#### Azure OpenAI
| Parámetro | Descripción | Por defecto |
| ------------------------------ | ------------------------------------------------------------------- | ----------------------------------------- |
| `azure_openai_api_endpoint` | Punto de conexión de Azure OpenAI | `${{ env.AZURE_OPENAI_API_ENDPOINT }}` |
| `azure_openai_api_key` | Clave de API de Azure OpenAI (no necesaria para Microsoft Entra ID) | `${{ secrets.AZURE_OPENAI_API_KEY }}` |
| `azure_openai_subscription_id` | ID de suscripción para la lista de implementaciones (solo Entra ID) | `${{ env.AZURE_OPENAI_SUBSCRIPTION_ID }}` |
| `azure_openai_api_version` | Versión de la API de Azure OpenAI | `${{ env.AZURE_OPENAI_API_VERSION }}` |
| `azure_openai_api_credentials` | Tipo de credenciales de API | `${{ env.AZURE_OPENAI_API_CREDENTIALS }}` |
#### Alias de Modelo
| Parámetro | Descripción | Por defecto |
| ------------- | -------------------------------------------------- | ----------- |
| `model_alias` | Una cadena similar a YAML de `alias: modelid`pares | |
Consulta la documentación de [Modelos](/action-continuous-translation/models/) para más detalles.
## 📤 Salidas
| Salida | Descripción |
| ------ | ------------------------------------------- |
| `text` | El texto generado como salida de traducción |
## 🚀 Inicio Rápido
### Configuración Sencilla
Agrega este paso a tu flujo de trabajo de GitHub Actions para traducir tu README a francés y español:
```yaml
uses: pelikhan/action-continuous-translation@v0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
lang: fr,es
```
### Ejemplo Completo de Flujo de Trabajo
Guarda este archivo en tu directorio `.github/workflows/` como `continuous-translation.yml`:
```yaml
name: Continuous Translation
on:
workflow_dispatch:
push:
branches:
- main
paths:
- "README.md"
- "docs/src/content/docs/**"
permissions:
contents: write
models: read
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
continuous_translation:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/cache@v4
with:
path: .genaiscript/cache/**
key: continuous-translation-${{ github.run_id }}
restore-keys: |
continuous-translation-
- uses: pelikhan/action-continuous-translation@v0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
lang: fr,es
- uses: stefanzweifel/git-auto-commit-action@v5
with:
file_pattern: "**.md* translations/**"
commit_message: "[cai] translated docs"
commit_user_name: "genaiscript"
```
**Hecho con ❤️ usando [GenAIScript](https://microsoft.github.io/genaiscript/)**