Refatora quase tudo #50

Eduardo-Barreto · 2025-03-17T03:49:53Z

Salve galera! Ja faz um tempo que estamos comentando que o template não refletia tao bem o jeito que faziamos as coisas na equipe

essa pr aqui basicamente junta tudo que havia de ruim e passa o caminhao

Resumidamente:

Migra pra C++
Migra pra Clang format
Adiciona Linter
Adiciona Docker
Adiciona Doxygen
Migra pro CMake do CubeMX ao inves do obko
Muda o uC pra o da bluepill
Corrige outros erros

Co-authored-by: Bruno1406 <[email protected]>

Co-authored-by: Lucas Haug <[email protected]>

Team-Micras/MicrasFirmware@de540ec

Eduardo-Barreto · 2025-03-29T20:05:37Z

Ou não usar o cmake do cube rsrsrs

Copilot

Pull Request Overview

This PR refactors several parts of the project by migrating to C++, integrating Clang Format, adding a linter and Docker configuration, updating CMake configuration, and switching the target microcontroller.

Introduces new GitHub Actions workflows for release and CI processes
Adds configuration files for Clang-Tidy and Clang-Format to enforce code quality
Updates project infrastructure including Docker, Doxygen, and microcontroller settings

Reviewed Changes

Copilot reviewed 30 out of 46 changed files in this pull request and generated 1 comment.

File	Description
.github/workflows/release.yaml	Adds a new release workflow that builds the project in Docker and attaches binaries to releases
.github/workflows/ci.yaml	Introduces a CI workflow for pull requests and pushes with cache, formatting, building, and linting
.clang-tidy	Provides a comprehensive linting configuration for C++ code
.clang-format	Establishes a consistent C++ formatting style using Clang-Format

Files not reviewed (16)

.devcontainer.json: Language not supported
.docker/.dockerignore: Language not supported
.docker/Dockerfile: Language not supported
.docker/scripts/build.sh: Language not supported
.docker/scripts/check_format.sh: Language not supported
.editorconfig: Language not supported
.githooks/pre-commit: Language not supported
.gitmodules: Language not supported
.vscode/extensions.json: Language not supported
.vscode/settings.json: Language not supported
.vscode/tasks.json: Language not supported
CMakeLists.txt: Language not supported
Doxyfile: Language not supported
LICENSE: Language not supported
PreLoad.cmake: Language not supported
cmake/config_validation.cmake: Language not supported

.github/workflows/release.yaml

.github/workflows/ci.yaml

LucasHaug · 2025-04-04T17:54:40Z

.github/workflows/ci.yaml

+      - name: 🔨 Build project
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: docker run --rm project:build /bin/bash /project/.docker/scripts/build.sh
+
+      - name: 🚨 Lint project
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: docker run --rm project:build /bin/bash /project/.docker/scripts/build.sh -DLINTER_MODE=ON


Não olhei tão a fundo, mas precisa desses dois estágios? O o build já não é feito junto do linting?

verdade, acho q eh melhor juntar nesse caso

a única diferença de resultado eh que quando roda com lint não tem binários de saída, mas como o CI não usa eu acho legal, já eh bom que diminui o tempo do check

a gnt tbm perde a clareza da informação se falhou na compilação ou no lint, mas acho q tá suave

Pra ambos os casos teria que olhar os logs pra ver o que falhou, então acho que não é tanto um problema. E aí economizar tempo na CI sempre ajuda, ainda mais pra projetos grandes aushhshshshsu

Eu ainda digo que esse if de cache em todos os steps não faz sentido nenhum e tem que ter uma forma melhor

Analisando melhor, acho que vale destacar uma troca importante entre clareza e performance aqui.

Atualmente, temos dois estágios separados: um para o build puro e outro para o build com lint. A proposta de juntar os dois ajuda a economizar tempo no CI, mas tem algumas implicações.

Comparativo entre os cenários

Build sem linter (estágios separados):

⏱️ Build puro: ~23s 🧹 Lint (com build): ~3min 🔍 Time-to-fail se o código não compila: 23s 🔍 Time-to-fail se o lint falha: ~3min 23s

Build com linter somente (estágios unificados):

🔄 Tudo junto: ~3min 🔍 Time-to-fail para qualquer falha: sempre até 3min

Ou seja, se o código não compila, o CI gasta 3 minutos para descobrir algo que poderia ser pego em 23 segundos. Isso pode ser relevante principalmente quando estamos em uma iteração rápida ou PRs mais simples.

Além disso, com os estágios separados, a gente ganha um pouco mais de clareza visual no resultado do CI, já que conseguimos ver diretamente se falhou no build ou no lint pelo nome do step (com o emojizinho bonitinho :p). Se unificarmos, isso se perde, aí todo erro vai parecer um erro do "build+lint"

Por outro lado…

É justo dizer que falhas de compilação são menos comuns em branches que sobem PRs, então há um argumento forte pra otimizar pro caso comum (sucesso), e evitar rodar o build puro à toa.

Eu particularmente acho que tanto faz kkkkkkkkkkkkkkkk mas como eu gosto dos emojis tendo a manter como está. De qualquer modo, é uma coisa extremamente simples que pode ser configurada pelo projeto se ele nao gostar do jeito que está

Co-authored-by: Gabriel Cosme Barbosa <[email protected]>

cmake/config_validation.cmake

Co-authored-by: Gabriel Cosme Barbosa <[email protected]>

GabrielCosme · 2025-04-24T14:22:27Z

cmake/config_validation.cmake

-else()
-    message(FATAL_ERROR "CUBE_PATH not defined")
+# Check if host system is Linux
+if(NOT CMAKE_HOST_SYSTEM_NAME STREQUAL "Linux")


Suggested change

if(NOT CMAKE_HOST_SYSTEM_NAME STREQUAL "Linux")

if(NOT CMAKE_HOST_UNIX)

Acho que se deixar assim ele suporta MacOS também.

GabrielCosme · 2025-04-24T14:23:28Z

cmake/config_validation.cmake

+    message(STATUS "Linux detected")
+    set(CUBE_DEFAULT_PATH "/usr/local/STMicroelectronics/STM32Cube/STM32CubeMX")


Suggested change

message(STATUS "Linux detected")

set(CUBE_DEFAULT_PATH "/usr/local/STMicroelectronics/STM32Cube/STM32CubeMX")

if (CMAKE_HOST_APPLE)

message(STATUS "MacOS detected")

set(CUBE_DEFAULT_PATH "/Applications/STMicroelectronics/STM32CubeMX.app")

else()

message(STATUS "Linux detected")

set(CUBE_DEFAULT_PATH "/usr/local/STMicroelectronics/STM32Cube/STM32CubeMX")

endif()

Tem que pedir pra alguém com Mac testar se só isso é suficiente.

GabrielCosme · 2025-04-27T22:33:19Z

.github/workflows/ci.yaml

+        if: steps.cache.outputs.cache-hit != 'true'
+        uses: docker/build-push-action@v6


Suggested change

if: steps.cache.outputs.cache-hit != 'true'

uses: docker/build-push-action@v6

if: steps.cache.outputs.cache-hit != 'true'

timeout-minutes: 10

uses: docker/build-push-action@v6

GabrielCosme · 2025-04-27T22:33:41Z

.github/workflows/release.yaml

+      - name: 🐋 Build Docker image
+        uses: docker/build-push-action@v6


Suggested change

- name: 🐋 Build Docker image

uses: docker/build-push-action@v6

- name: 🐋 Build Docker image

timeout-minutes: 10

uses: docker/build-push-action@v6

Eduardo-Barreto and others added 30 commits October 21, 2023 14:51

🔧 Update CMakeLists to cpp

bd10771

⬆️ Update cube

0050396

✨ Migrate mcu utility to cpp

f93583d

📝 Update README

aa33fbb

📝 Update file header

b0b8248

✨ Update tests to CPP

281e42c

✨ Readd C support

2b08065

Co-authored-by: Bruno1406 <[email protected]>

🔧 Set uncrustify as default formatter

693fe59

🎨 Function definitions inside namespace

345a274

Co-authored-by: Bruno1406 <[email protected]>

🎨 Format with uncrustify

545a38e

📝 Fix guard macros name

fd43d6c

Co-authored-by: Lucas Haug <[email protected]>

📝 Fix guard macros name comment

6689168

Co-authored-by: Lucas Haug <[email protected]>

🩹 Rename C_Things to PROJECT_Things

42f102d

🔥 Remove mcu led toggle

c6497cd

Merge branch 'migrate/cpp' into the-great-refactor

b84c4e1

🔧 Change Cube toolchain to CMake

28c3444

🔧 Change uncrustify to clang

7b63f56

✨ Add linter

127c0e5

♻️ Refactor structure to new cmake

e969f47

🔇 Remove debug logs

e82cafa

✨ Add test_all target

95d5d61

🚨 Fix linter warnings

7c7f99f

♻️ Update targets

34d1f55

⬆️ Update extensions recommendations

ffd8dca

🚧 Add doxyfile

523b026

✨ Add gpio and test

800bc6d

♻️ Change uc to bluepill

23fbab4

✨🚧 Start to add docker

af15935

👷 Add CI

99fd511

🚨 Initialize config members

a6838dc

Eduardo-Barreto added 3 commits March 29, 2025 16:05

🔇 Make docs in batch mode

2d6137d

🐛 Fix CUBE_SOURCE_DIR assignment for WSL and Linux environments

1394dfe

Team-Micras/MicrasFirmware@de540ec

🔥 Remove editorconfig

4ca3db8

Eduardo-Barreto added 8 commits March 29, 2025 17:40

🎨 Fix include orders

4204ab0

🎨 Fix line breaking

a6d880a

🔧 Optimize clang-format rules

ebde7d4

🙈 Ignore docs folder

20f7740

🔧 Optimize doxyfile

398e932

✏️ Fix typo

625323f

📝 Add english README

07ab85b

📄 Update LICENSE

3510d44

Eduardo-Barreto requested a review from VanderSant March 29, 2025 21:34

This was referenced Mar 29, 2025

Readme do template em inglês #44

Open

config.mk família STM32L4 #45

Open

GabrielCosme approved these changes Mar 29, 2025

View reviewed changes

Eduardo-Barreto requested a review from a team March 29, 2025 22:27

Eduardo-Barreto added 2 commits March 31, 2025 13:23

♻️ Change githook to clang-format

30676f7

🔥 Remove gitmodules file

36abad5

Eduardo-Barreto requested a review from Copilot April 3, 2025 11:16

Copilot AI reviewed Apr 3, 2025

View reviewed changes

.github/workflows/release.yaml Outdated Show resolved Hide resolved

🩹 Use standard token reference

dd4ba09

GabrielCosme reviewed Apr 3, 2025

View reviewed changes

.github/workflows/ci.yaml Show resolved Hide resolved

LucasHaug reviewed Apr 4, 2025

View reviewed changes

💚 Add ready for review trigger on pull request ci

98ecbc9

Co-authored-by: Gabriel Cosme Barbosa <[email protected]>

GabrielCosme reviewed Apr 16, 2025

View reviewed changes

cmake/config_validation.cmake Outdated Show resolved Hide resolved

🔧🐛 Support for basic and advanced code generation

0120c51

Co-authored-by: Gabriel Cosme Barbosa <[email protected]>

GabrielCosme reviewed Apr 24, 2025

View reviewed changes

GabrielCosme reviewed Apr 27, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Refatora quase tudo #50

Refatora quase tudo #50

Uh oh!

Eduardo-Barreto commented Mar 17, 2025 •

edited

Loading

Uh oh!

Eduardo-Barreto commented Mar 29, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

LucasHaug Apr 4, 2025

Uh oh!

Eduardo-Barreto Apr 4, 2025

Uh oh!

Eduardo-Barreto Apr 4, 2025

Uh oh!

LucasHaug Apr 4, 2025

Uh oh!

d-nery Apr 4, 2025

Uh oh!

Eduardo-Barreto Apr 13, 2025

Uh oh!

Uh oh!

GabrielCosme Apr 24, 2025

Uh oh!

GabrielCosme Apr 24, 2025

Uh oh!

GabrielCosme Apr 27, 2025

Uh oh!

GabrielCosme Apr 27, 2025

Uh oh!

Uh oh!

	if(NOT CMAKE_HOST_SYSTEM_NAME STREQUAL "Linux")
	if(NOT CMAKE_HOST_UNIX)

		message(STATUS "Linux detected")
		set(CUBE_DEFAULT_PATH "/usr/local/STMicroelectronics/STM32Cube/STM32CubeMX")

		if: steps.cache.outputs.cache-hit != 'true'
		uses: docker/build-push-action@v6

		- name: 🐋 Build Docker image
		uses: docker/build-push-action@v6

Refatora quase tudo #50

Are you sure you want to change the base?

Refatora quase tudo #50

Uh oh!

Conversation

Eduardo-Barreto commented Mar 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Eduardo-Barreto commented Mar 29, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Comparativo entre os cenários

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Eduardo-Barreto commented Mar 17, 2025 •

edited

Loading