Adiciona Makefile e ativa GitHub Actions #10
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Esta PR tem o intuito de simplificar e automatizar a execução de algumas tarefas para a equipe, permitindo o seguinte:
Usando GitHub Actions
Para visualizar os "workflows" de Ghub Actions e seus estados, basta clicar na aba "Actions" ao lado de "Pull requests". Pelo Actions do meu fork pode-se ver uma lista de tarefas com seu resultado negativo ❌ caso a execução tenha retornado algum erro.
A configuração que fiz para o Actions e para o Makefile é compilar a documentação do Python considerando "warnings" como "erros", de forma que seja chamada a atenção de qualquer erro de sintaxe da tradução.
No erro, os mantenedores/desenvolvedores do repositório receberão notificação por e-mail.
Sobre os arquivos desta Pull Request
Makefile
Baseado no Makefile da equipe francesa de tradução do Python, o Makefile fornecido aqui foi adaptado ao fluxo de trabalho da equipe brasileira. Explico: enquanto o fluxo de trabalho da equipe francesa é pelo GitHub, a equipe brasileira utiliza o Transifex. Na prática significa que nosso Makefile pode considerar que o arquivo PO obtido do Transifex está atualizado com o modelo do último commit da documentação do Python. Já a equipe francesa, precisa saber com qual hash de commit do repositório cpython sua tradução está sincronizado, utilizando a variável CPYTHON_CURRENT_COMMIT.
O Makefile fornecido permite o seguinte:
make
- exibe mensagens de ajudamake build
- prepara o ambiente e compila a documentaçãomake update
- baixa traduções do Transifex, faz commit e push para o repositório brasileiromake serve
- apósmake build
, fornece a documentação numa páginamake todo
- lista traduções incompletas, com estatísticasmake fuzzy
- mostra fuzzy (1)make spell
- verifica a ortografia dos últimos arquivos enviados (2)make wrap
- ajusta/verifica quebra de linha (3)make verifs
- chama ambos spell e wrapmake progress
- computa e mostra a porcentagem da documentação(1) - tenho que testar o fuzzy melhor, não sei se está funcionando
(2) - spell talvez pudesse verificar todos os arquivos, em vez de apenas os últimos
(3) - não sei qual a necessidade desse wrap, tem verificar
Me parece que os mais úteis são
make build
emake update
, pois um compila a documentação acusando erros de formatação e o outro atualiza e faz commit em um só comando..github/workflows/pythonpackage.yml
Arquivo de configuração para o GitHub Actions, esse arquivo está configurado para ser executado somente quando é feito commit de arquivos PO. Ele instala as dependências para seu funcionamento e executar alguns comandos, em especial o
make build
para falhar no caso de algum erro nos arquivos PO.Se houver algum erro de sintaxe no arquivo PO, a execução falhará, indicando que algo tem que ser corrigido.
.gitignore
Adicionado para não exibir arquivos do processo de compilação.