Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

288 - Alterando pre-commit hook para pre-push #291

Merged
merged 12 commits into from
Nov 28, 2023

Conversation

MarcelFox
Copy link
Contributor

@MarcelFox MarcelFox commented Nov 25, 2023

Descrição

Alterar o pre-commit hook para ser um pre-push hook para facilitar o fluxo de desenvolvimento onde a checagem de código será feita apenas no push e não a cada commit.

Mudanças Propostas

  • pre-commit removido
  • Adicionado modificação de diretório de githook no make install
  • Melhorias efetuadas no poetry para o ruff check (como estava não formatava efetivamente)
  • pre-push hook adicionado

Checklist de Revisão

  • Eu li o Contributing.md
  • Os testes foram adicionados ou atualizados para refletir as mudanças (se aplicável).
  • Foi adicionada uma entrada no changelog / Meu PR não necessita de uma nova entrada no changelog.
  • A documentação em português foi atualizada ou criada, se necessário.
  • Se feita a documentação, a atualização do arquivo em inglês.
  • Eu documentei as minhas mudanças no código, adicionando docstrings e comentários. Instruções
  • O código segue as diretrizes de estilo e padrões de codificação do projeto.
  • Todos os testes passam. Instruções
  • O Pull Request foi testado localmente. Instruções
  • Não há conflitos de mesclagem.

Comentários Adicionais (opcional)

O que não foi marcado acima não se aplica uma vez que é uma mudança relacionada a estrutura do projeto.

Issue Relacionada

Closes #288

@MarcelFox MarcelFox requested review from a team as code owners November 25, 2023 21:58
Copy link

codecov bot commented Nov 25, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (388c671) 100.00% compared to head (f433b8d) 100.00%.

❗ Current head f433b8d differs from pull request most recent head 18b3a89. Consider uploading reports for the commit 18b3a89 to get more accurate results

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #291   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           10        10           
  Lines          296       296           
=========================================
  Hits           296       296           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@MarcelFox
Copy link
Contributor Author

MarcelFox commented Nov 25, 2023

Olha o fluxo de funcionamento, se adicionamos um commit que não vai passar no ruff, o push não é realizado e uma mensagem para formatar o código é exibida:

image

Copy link
Member

@camilamaia camilamaia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MarcelFox valeu pela contribuição! Deixei duas sugestões apenas com pequenos detalhes.

.githooks/pre-push Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
@@ -9,12 +10,10 @@ run-python:
@poetry run python

format:
@poetry run ruff format .
@poetry run ruff .
@poetry run ruff check . --fix
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MarcelFox Você sabe dizer qual a diferença entre @poetry run ruff check . --fix e @poetry run ruff . --fix? Eu usei o segundo e funcionou bem também.

Copy link
Contributor Author

@MarcelFox MarcelFox Nov 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

O ruff check . --fix de fato corrige possíveis problemas encontrados, de acordo com a ducumentação:

image

Já o ruff . --fix não parece ser uma opção:
image

O que fiquei sem entender é o format que pra mim não fez nada. O check funcionou tanto pra checar quanto pra corrigir os erros encontrados e aparentemente formatou o código então optei por ele.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Faz sentido, valeu! Também não tinha achado na doc

MarcelFox and others added 2 commits November 27, 2023 13:48
Co-authored-by: Camila Maia <cmaiacd@gmail.com>
Co-authored-by: Camila Maia <cmaiacd@gmail.com>
@camilamaia camilamaia merged commit 800f839 into brazilian-utils:main Nov 28, 2023
This was referenced Nov 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Trocar o tipo de git hook utilizado para formatação de código
2 participants