Merge PR #32 (feature/upload-corevage-to-codeclimate) into feature/ad…

…d-github-workflow-for-pull-requests

.github/workflows/pull-request.yaml

@@ -33,6 +33,16 @@ jobs:
       - name: pipenv run test
         run: pipenv run test
 
+      - name: Coverage upload
+        if: ${{matrix.python == '3.8'}}
+        uses: paambaati/codeclimate-action@v2.7.4
+        env:
+          CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}
+
+      - name: Coverage Skipped
+        if: ${{matrix.python != '3.8'}}
+        run: echo "Coverage uploaded only on python 3.8 run"
+
   lint:
     name: lint
     runs-on: ubuntu-latest

README.md

@@ -53,6 +53,9 @@ Esse repositorio já possui alguns workflows do Github Actions pré-configurados
 
     Esse workflow roda em cada PR aberto no projeto. Roda os testes em múltiplas versões do python e faz checagem de formatação de código, lint (com mypy) e formatação de imports (com isort).
 
+    Esse workflow faz também upload do relatório de coverage para o [codeclimate](https://codeclimate.com). Perceba que o upload é feito em apenas um versão do python, isso porque o codeclimate rejeita múltiplos upload para um mesmo commit, então precisamos escolher uma das rodadas de teste para fazer o upload.
+
+    Para que o upload para o codeclimate funciona você precisa criar um token no CodeClimate e colocar esse token como um secret no seu repositório. O Nome do secret **deve ser**: ``CC_TEST_REPORTER_ID``. Mais sobre a documentação do codeclimate com githubactions: https://docs.codeclimate.com/docs/github-actions-test-coverage
 
 # Pydantic - Configuração baseada em variáveis de ambiente