Yuki-no : une GitHub Action pour les projets open source de traduction de documentation
(github.com/Gumball12)Bonjour. Je voudrais présenter un projet open source développé dans le cadre du projet de traduction de la documentation coréenne de Vite.
Yuki-no (Gumball12/yuki-no)
Dans un travail de traduction, le suivi des modifications de la documentation source est essentiel. Sinon, on risque de traduire des passages incorrects ou d’en omettre certains.
Pour cela, nous utilisions jusqu’à présent un projet open source appelé Ryu-Cho. Ce projet utilise GitHub Actions pour enregistrer les changements du dépôt source dans les GitHub Issues du dépôt de traduction afin de les signaler. Cependant, après près de deux ans d’utilisation, j’ai identifié plusieurs points à améliorer.
- En cas d’échec de l’Action, toutes les modifications du dépôt source qui n’ont pas pu être traitées sont perdues et ne sont pas enregistrées dans les GitHub Issues. Cela peut conduire à manquer une partie du contenu source.
- La méthode de filtrage des fichiers à suivre est très limitée (comparaison par préfixe de chaîne).
- Il n’est pas possible de définir des labels sur les issues créées, ce qui peut les mélanger avec d’autres issues et les rendre moins lisibles d’un coup d’œil.
- L’outil n’indique pas si les modifications de la documentation source ont été publiées dans une release. Cela peut conduire à diffuser trop tôt du contenu qui n’a pas encore été publié.
J’ai développé ce projet pour répondre à ces problèmes, avec les fonctionnalités suivantes :
- Amélioration de la stabilité de l’Action grâce au traitement par lots (fonctionnement confirmé avec plus de 200 commits)
- En cas d’échec de l’Action, récupération automatique lors de l’exécution suivante
- Fonction de suivi des releases (exemple : projet de traduction coréenne de Vite)
- Filtrage des cibles de suivi basé sur des motifs Glob
- Possibilité de définir des labels personnalisés pour les issues créées
Le projet est actuellement utilisé dans les projets suivants :
- Projet officiel de traduction coréenne de Vite (issues générées)
- Projet officiel de traduction coréenne de Vue.js
- Template de traduction Vite
Si vous prévoyez de lancer un projet de traduction, si vous avez besoin d’aide pour la configuration, notamment lors d’une migration, ou si le projet vous intéresse, n’hésitez pas à me contacter à tout moment via GitHub Issues ou par e-mail (to@shj.rip). Merci.
Aucun commentaire pour le moment.