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

Package source files and update actions #1254

Merged
merged 49 commits into from
Sep 27, 2024
Merged

Package source files and update actions #1254

merged 49 commits into from
Sep 27, 2024

Conversation

Davknapp
Copy link
Collaborator

Use CPack to create a target to package source files (binary packaging will not be supported by this)

Furthermore a github action is added to check the proper creation of the tar-ball.

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.scp 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)

@Davknapp Davknapp added the CMake Is about the CMake build system label Sep 24, 2024
jmark
jmark previously requested changes Sep 26, 2024
Copy link
Collaborator

@jmark jmark left a comment

Choose a reason for hiding this comment

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

On my machine the "version.txt" file is not created.

I'm using cmake version 3.23.1.

@jmark jmark dismissed their stale review September 26, 2024 15:33

Just saw that one has to individually call version target

@Davknapp
Copy link
Collaborator Author

The version file is created automatically when the code is compiled. If you only want to pack it, it has to be triggered manually

Copy link
Collaborator

@jmark jmark left a comment

Choose a reason for hiding this comment

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

LGTM! Nice work! Just have a minor suggestion.

CMakeLists.txt Outdated Show resolved Hide resolved
@jmark jmark merged commit de463b8 into main Sep 27, 2024
25 checks passed
@jmark jmark deleted the Cpack branch September 27, 2024 11:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CMake Is about the CMake build system
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants