aiidateam / aiida-core

The official repository for the AiiDA code
https://aiida-core.readthedocs.io
Other
411 stars 184 forks source link

Devops: Remove `verdi tui` from CLI reference documentation #6464

Closed sphuber closed 3 weeks ago

sphuber commented 3 weeks ago

The verdi-autodocs pre-commit hook automatically generates the reference documentation for verdi. It does so based on the available commands. The verdi tui command is added dynamically if and only if the optional dependency trogon is installed.

Since having the dependency installed slows down the loading time verdi significantly, many dev environments prefer not to install it. However, this leads to the verdi-autodocs hook always failing as it removes the verdi tui section from the docs. The developer then has to manually reset the changes and run git commit with --no-verify.

This is annoying enough that as a workaround the verdi-autodocs hook now skips the verdi tui command when generating the docs.

codecov[bot] commented 3 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 77.77%. Comparing base (ef60b66) to head (b41cfe3). Report is 37 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #6464 +/- ## ========================================== + Coverage 77.51% 77.77% +0.27% ========================================== Files 560 562 +2 Lines 41444 41759 +315 ========================================== + Hits 32120 32475 +355 + Misses 9324 9284 -40 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

danielhollas commented 3 weeks ago

Thanks so much for this, it was suuuprr annoying.

It would be nice if the TUI did not slow down the normal verdi usage so much, i.e. if we good import it only lazily when user actually uses the TUI. But I haven't figured out how to do it.

sphuber commented 3 weeks ago

Thanks so much for this, it was suuuprr annoying.

Yeah, now just to fix the one where the default email for the profile setup command is changed to the autofill.email config option if defined 😅