https://github.com/lin-jun-xiang/action-translate-readme
Free GPT Auto Generate and Translate the README in Multiple Languages via CI/CD
https://github.com/lin-jun-xiang/action-translate-readme
action chatgpt ci-cd cicd github-actions gpt gpt3 gpt4free markdown readme translation
Last synced: about 2 months ago
JSON representation
Free GPT Auto Generate and Translate the README in Multiple Languages via CI/CD
- Host: GitHub
- URL: https://github.com/lin-jun-xiang/action-translate-readme
- Owner: Lin-jun-xiang
- License: mit
- Created: 2023-04-28T06:04:00.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-11T09:42:50.000Z (3 months ago)
- Last Synced: 2025-03-16T01:41:21.078Z (about 2 months ago)
- Topics: action, chatgpt, ci-cd, cicd, github-actions, gpt, gpt3, gpt4free, markdown, readme, translation
- Language: Python
- Homepage: https://github.com/marketplace/actions/auto-translate-readme
- Size: 64.6 MB
- Stars: 42
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.French.md
- License: LICENSE
Awesome Lists containing this project
README
# action-translate-readme
* [English](README.md)
* [繁體中文版README.md](README.zh-TW.md)
* [简体中文](README.zh-CN.md)
* [Française](README.French.md)
# Introduction
**GitHub Action pour traduire le Readme dans n'importe quelle langue**
Il s'agit d'une GitHub Action qui traduit automatiquement le readme de votre dépôt dans une langue spécifiée.
> [!NOTE]
> La version `v1` du traducteur est implémentée via un package tiers `Linux` ; la version `v2` est implémentée via une IA générative pour la traduction.
* Nous savons tous que rédiger des documents README est chronophage, mais il existe maintenant une solution pour gagner la moitié du temps. C'est notre `action-translate-readme`
* Traduire différentes versions linguistiques du README via **l'IA générative**
* **Commiter et pousser** automatiquement les fichiers traduits via **GitHub Actions (CI/CD)**
* Par exemple : **Écrire** ou **Modifier** la version anglaise du README, générer automatiquement les versions en chinois traditionnel, chinois simplifié, français... et autres versions du README
# Comment utiliser ?
> [!IMPORTANT]
> Étant donné que le résultat de la traduction par le modèle d'IA générative peut présenter des problèmes occasionnellement, il est recommandé d'effectuer les opérations sur une branche et de fusionner ensuite avec la branche principale.
> [!WARNING]
> Si vous rencontrez cette erreur : `Error: Input required and not supplied: token`, veuillez vous assurer que `Token` est établi comme indiqué à l'étape deux ci-dessous, ou vérifiez si le `Token` a expiré !
1. Cliquez sur l'icône :star: pour ajouter cet élément à votre dépôt GitHub.
2. Configurez votre `GitHub Token` (**obligatoire**) :
1. [Créer un nouveau **`GitHub Secret Token`**](https://github.com/settings/tokens/new)
* Paramètres
* Paramètres développeur
* Jetons d'accès personnels - `Tokens(classic)`
* Générer un nouveau jeton
* Choisir la **durée de vie** du jeton - il est recommandé d'utiliser **permanently**
* Sélection de la portée : `repo` et `workflow`
* **Conservez** votre jeton secret (ne le perdez pas, vous devrez le coller plus tard)
2. Ajoutez le GitHub Token aux **`secrets du dépôt`**
* Dans votre dépôt - `settings`
* `Sécurité et variables`
* `Actions`
* `Nouveau secret de dépôt`
* Remplissez l'étiquette et nommez-le avec `token` (par exemple, `Action_Bot`)
3. Choisissez le modèle de traduction GPT (**optionnel**)
* `g4f` : **Par défaut**, utilise **gratuitement** `g4f` pour les appels OpenAI afin de réaliser les tâches de traduction.
* `zhipuai` : Si vous avez besoin d'une traduction **gratuite et stable**, vous pouvez vous inscrire sur la [Plateforme Zhipuai AI](https://open.bigmodel.cn/dev/howuse/introduction) et [demander un API KEY](https://open.bigmodel.cn/usercenter/proj-mgmt/apikeys), qui est un modèle GPT completely gratuit sans nécessiter de carte de crédit.
* Pour utiliser cette option, veuillez suivre la méthode d'ajout du GitHub Token à **l'étape 2-2**, et ajouter **API KEY de Zhipuai AI aux Secrets de GitHub Repos**.
* `openai` : **Garantit une qualité élevée et stable**, si vous avez un OPENAI API KEY, `gpt-4o` sera utilisé comme modèle de traduction.
* Pour utiliser cette option, veuillez suivre la méthode d'ajout du GitHub Token à **l'étape 2-2**, et ajouter **API KEY d'OpenAI aux Secrets de GitHub Repos**.
4. Créez votre exemple d'action dans `.github/workflows/your_action.yml`. Vous pouvez directement copier ce qui suit :
```yaml
# .github/workflows/translate.yml
name: Traduire Readme
on:
push:
branches: ['**']
jobs:
translate:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 3
- name: Traduction automatique
uses: Lin-jun-xiang/action-translate-readme@v2 # Basé sur le tag
with:
token: ${{ secrets.Action_Bot }} # Basé sur le nom de l'étape 2
zhipuai: ${{ secrets.zhipuai_api_key }} # Optionnel : Basé sur l'étape 3
openai: ${{ secrets.openai_api_key }} # Optionnel : Basé sur l'étape 3
langs: "en,zh-TW,zh-CN,French,Arabic" # Vous pouvez définir n'importe quelles langues
```
Faites attention à plusieurs paramètres dans le `.yml` :
* `token` : GitHub Token pour autoriser l'opération (ajouté comme indiqué à l'étape deux).
* `zhipuai` : API Zhipuai, ajouté comme indiqué à l'étape trois (optionnel)
* `openai` : API OpenAI, ajouté comme indiqué à l'étape trois (optionnel)
* `langs` : Spécifiez les langues à traduire, assurez-vous de séparer les différentes langues par `,` comme :
* `"en"` : Traduire uniquement la version anglaise
* `"en,zh-TW"` : Traduire l'anglais, le chinois traditionnel
* `"French,Arabic"` : Traduire le français, l'arabe
> PS : Si ni `zhipuai` ni `openai` n'est ajouté aux Secrets de GitHub, `g4f` sera utilisé pour la traduction.
5. Maintenant, vous pouvez mettre à jour `README.md`, et il générera automatiquement une version traduite !
---
# Démo
# Résultats du document de test
* Voir le [document de test](https://github.com/Lin-jun-xiang/ChatGPT-line-bot) qui a utilisé notre outil pour mettre à jour les documents.