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

[4/4] Add valgrind check to ci #1460

Open
wants to merge 34 commits into
base: main
Choose a base branch
from
Open

Conversation

lenaploetzke
Copy link
Collaborator

Describe your changes here:

Add valgrind check to ci.
This is the fourth step of #1441.
See also #1438 and #1452 and #1453.

All these boxes must be checked by the reviewers before merging the pull request:

As a reviewer please read through all the code lines and make sure that the code is fully understood, bug free, well-documented and well-structured.

General

  • The reviewer executed the new code features at least once and checked the results manually

  • The code follows the t8code coding guidelines

  • New source/header files are properly added to the Makefiles

  • The code is well documented

  • All function declarations, structs/classes and their members have a proper doxygen documentation

  • All new algorithms and data structures are sufficiently optimal in terms of memory and runtime (If this should be merged, but there is still potential for optimization, create a new issue)

Tests

  • The code is covered in an existing or new test case using Google Test

Github action

  • The code compiles without warning in debugging and release mode, with and without MPI (this should be executed automatically in a github action)

  • All tests pass (in various configurations, this should be executed automatically in a github action)

    If the Pull request introduces code that is not covered by the github action (for example coupling with a new library):

    • Should this use case be added to the github action?
    • If not, does the specific use case compile and all tests pass (check manually)

Scripts and Wiki

  • If a new directory with source-files is added, it must be covered by the script/find_all_source_files.sh to check the indentation of these files.
  • If this PR introduces a new feature, it must be covered in an example/tutorial and a Wiki article.

License

  • The author added a BSD statement to doc/ (or already has one)

Tag Label

  • The author added the patch/minor/major label in accordance to semantic versioning.

@lenaploetzke lenaploetzke force-pushed the 1441-add-valgrind-to-ci-4 branch from d0556f5 to ec5c6f7 Compare March 6, 2025 10:00
@lenaploetzke lenaploetzke mentioned this pull request Mar 6, 2025
15 tasks
@lenaploetzke lenaploetzke marked this pull request as ready for review March 7, 2025 13:21
@lenaploetzke
Copy link
Collaborator Author

We still need to discuss when to trigger the valgrind job, as it runs for about 52 minutes. Maybe only in the nightly run?

@Davknapp
Copy link
Collaborator

Davknapp commented Mar 7, 2025

We still need to discuss when to trigger the valgrind job, as it runs for about 52 minutes. Maybe only in the nightly run?

That is a good idea, in my mind. We will probably have a more in depth discussion about our CI in two weeks, we can discuss it then.

Thank you for this awesome action though! It is nice, what we already detected with it!

@lenaploetzke
Copy link
Collaborator Author

FYI: I also ran the valgrind check on 5 processes and valgrind did not find any errors (except those already corrected).

@lenaploetzke lenaploetzke self-assigned this Mar 10, 2025
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.

2 participants