Yuki-no: Eine GitHub Action für Open-Source-Dokumentationsübersetzungsprojekte
(github.com/Gumball12)Hallo. Ich möchte ein Open-Source-Projekt vorstellen, das ich während der Arbeit am koreanischen Übersetzungsprojekt für die Vite-Dokumentation entwickelt habe.
Yuki-no (Gumball12/yuki-no)
Bei Übersetzungsarbeiten ist es sehr wichtig, Änderungen an der Originaldokumentation nachzuverfolgen. Andernfalls kann es leicht passieren, dass falsche Stellen übersetzt oder Teile des Inhalts ausgelassen werden.
Dafür wurde bisher das Open-Source-Projekt Ryu-Cho verwendet. Dieses Open Source nutzt GitHub Actions, um Änderungen im Original-Repository als GitHub Issues im Übersetzungs-Repository zu erfassen und darauf hinzuweisen. Bei fast zweijähriger Nutzung wurden jedoch einige Verbesserungsmöglichkeiten festgestellt.
- Wenn eine Action fehlschlägt, gehen alle nicht verarbeiteten Änderungen im Original-Repository verloren und werden nicht als GitHub Issues erfasst. Dadurch können Teile des Originalinhalts übersehen werden.
- Die Methode zum Filtern der zu verfolgenden Dateien ist sehr eingeschränkt (Vergleich per Präfix-String).
- Für erstellte Issues können keine Labels gesetzt werden, sodass sie sich mit anderen Issues vermischen und schwerer auf einen Blick zu erfassen sind.
- Es wird nicht angezeigt, ob Änderungen an der Originaldokumentation bereits veröffentlicht wurden. Dadurch kann es passieren, dass noch nicht veröffentlichte Inhalte zu früh bereitgestellt werden.
Es wurde mit dem Ziel entwickelt, diese Punkte zu verbessern, und bietet die folgenden Funktionen:
- Verbesserte Stabilität der Action durch Batch-Verarbeitung (bestätigt funktionsfähig für mehr als 200 Commits)
- Bei einem Fehlschlag der Action automatische Wiederherstellung beim nächsten Lauf
- Bereitstellung einer Release-Tracking-Funktion (Beispiel: koreanisches Vite-Übersetzungsprojekt)
- Filterung der zu verfolgenden Ziele auf Basis von Glob-Mustern
- Konfigurierbare benutzerdefinierte Labels für erstellte Issues
Derzeit wird es in den folgenden Projekten verwendet:
- Offizielles koreanisches Vite-Übersetzungsprojekt (erstellte Issues)
- Offizielles koreanisches Vue.js-Übersetzungsprojekt
- Vite-Übersetzungstemplate
Wenn Sie ein Übersetzungsprojekt planen, Unterstützung bei der Einrichtung etwa für eine Migration benötigen oder sich für das Projekt interessieren, kontaktieren Sie mich jederzeit über GitHub Issues oder per E-Mail (to@shj.rip). Vielen Dank.
Noch keine Kommentare.