Yuki-no: GitHub Action para projetos de tradução de documentação open source
(github.com/Gumball12)Olá. Gostaria de apresentar um projeto open source que desenvolvi enquanto trabalhava no projeto de tradução da documentação do Vite para coreano.
Yuki-no (Gumball12/yuki-no)
Em trabalhos de tradução, acompanhar mudanças na documentação original é muito importante. Caso contrário, você pode acabar traduzindo trechos incorretamente ou deixando partes do conteúdo de fora.
Para isso, antes usávamos um projeto open source chamado Ryu-Cho. Esse projeto usa GitHub Actions para registrar mudanças no repositório original como GitHub Issues no repositório de tradução e assim notificá-las. No entanto, após quase 2 anos de uso, encontramos alguns pontos de melhoria.
- Quando a Action falha, todas as mudanças no repositório original que não puderam ser processadas são perdidas e não são registradas como GitHub Issues. Isso faz com que partes do conteúdo original acabem ficando de fora.
- A forma de filtrar os arquivos rastreados é muito limitada (comparação por string inicial).
- Não é possível definir labels nas issues geradas, então elas podem se misturar com outras issues e ficar difíceis de identificar rapidamente.
- Não informa se as mudanças na documentação original já foram publicadas em uma release. Isso pode fazer com que conteúdo ainda não lançado seja disponibilizado cedo demais.
Ele foi desenvolvido com o objetivo de melhorar esses pontos e oferece os seguintes recursos:
- Maior estabilidade da Action por meio de processamento em lote (confirmado funcionamento normal com mais de 200 commits)
- Configurado para recuperar automaticamente, na próxima execução, falhas ocorridas na Action
- Recurso de rastreamento de releases (exemplo: projeto de tradução coreana do Vite)
- Filtragem dos arquivos rastreados com base em padrões Glob
- Possibilidade de definir labels customizadas para as issues geradas
Atualmente ele está sendo usado nos seguintes projetos:
- Projeto oficial de tradução coreana do Vite (issues geradas)
- Projeto oficial de tradução coreana do Vue.js
- Template de tradução do Vite
Se você pretende tocar um projeto de tradução, precisa de ajuda com configuração, migração ou tem interesse no projeto, entre em contato a qualquer momento pelo GitHub Issues ou por e-mail (to@shj.rip). Obrigado.
Ainda não há comentários.