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

Add a libtrixi cmake module #132

Merged
merged 23 commits into from
Oct 5, 2023
Merged

Add a libtrixi cmake module #132

merged 23 commits into from
Oct 5, 2023

Conversation

benegee
Copy link
Collaborator

@benegee benegee commented Oct 4, 2023

Resolves #121

Copy link
Member

@sloede sloede left a comment

Choose a reason for hiding this comment

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

Thanks for getting started on this. I think it would be great if we could also provide a test for this, e.g., if we add a CMakeLists.txt that shows how to build one of the examples against an existing libtrixi installation.

cmake/FindLibTrixi.cmake Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/src/index.md Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Oct 4, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (e165220) 98.05% compared to head (d7169d1) 98.05%.

❗ Current head d7169d1 differs from pull request most recent head 3427bec. Consider uploading reports for the commit 3427bec to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #132   +/-   ##
=======================================
  Coverage   98.05%   98.05%           
=======================================
  Files          13       13           
  Lines         565      565           
=======================================
  Hits          554      554           
  Misses         11       11           
Flag Coverage Δ
unittests 98.05% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

benegee and others added 6 commits October 4, 2023 17:03
Co-authored-by: Michael Schlottke-Lakemper <michael@sloede.com>
Co-authored-by: Michael Schlottke-Lakemper <michael@sloede.com>
[no ci]
@benegee benegee requested a review from sloede October 4, 2023 16:37
@sloede
Copy link
Member

sloede commented Oct 4, 2023

I haven't looked at it in detail, but we should add a test where the external CMakeLists.txt is actually used to build an example executable. Otherwise it is likely that the script will not work anymore at some point (see the Doxygen example from a few days ago 😬)

@benegee benegee requested review from sloede and removed request for sloede October 5, 2023 14:43
Copy link
Member

@sloede sloede left a comment

Choose a reason for hiding this comment

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

This looks very, very good imho, thanks a lost! Just one thought:
Right now, there is a lot of copy pasting in the CI such that a user does not just see what needs to be done from looking at the example CMakeLists.txt alone. Therefore, I suggest to

  • get rid of the copy paste stuff and
  • add a build.sh file that encapsulates the remaining commands.

That way, everything is tested in CI and nothing is "hidden" in some CI yml file.

I tried to implement this as suggestions, but I think there might be some things I missed.

examples/CMakeListsExternal.txt Outdated Show resolved Hide resolved
examples/CMakeListsExternal.txt Outdated Show resolved Hide resolved
examples/CMakeListsExternal.txt Outdated Show resolved Hide resolved
.github/workflows/ci.yml Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/src/index.md Outdated Show resolved Hide resolved
benegee and others added 7 commits October 5, 2023 18:38
Co-authored-by: Michael Schlottke-Lakemper <michael@sloede.com>
Co-authored-by: Michael Schlottke-Lakemper <michael@sloede.com>
Co-authored-by: Michael Schlottke-Lakemper <michael@sloede.com>
Co-authored-by: Michael Schlottke-Lakemper <michael@sloede.com>
Co-authored-by: Michael Schlottke-Lakemper <michael@sloede.com>
Copy link
Member

@sloede sloede left a comment

Choose a reason for hiding this comment

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

LGTM, with just one more (small) comment left

.github/workflows/ci.yml Outdated Show resolved Hide resolved
sloede
sloede previously approved these changes Oct 5, 2023
Copy link
Member

@sloede sloede left a comment

Choose a reason for hiding this comment

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

LGTM! Great work!

sloede
sloede previously approved these changes Oct 5, 2023
sloede
sloede previously approved these changes Oct 5, 2023
@sloede sloede enabled auto-merge (squash) October 5, 2023 20:04
@sloede sloede merged commit 56c92f3 into main Oct 5, 2023
8 checks passed
@sloede sloede deleted the libtrixi-cmake-module branch October 5, 2023 20:14
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.

Create FindLibtrixi.cmake
2 participants