Overhaul Build System #118
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR restructures the project's build system by migrating from a custom Makefile setup to a more modular GNU Make system. The key changes include:
- Introduction of a new modular build system using
GNUmakefileand shared makefiles inshare/mk/ - Migration of tests to use Catch2 framework exclusively, removing the dual-mode testing approach
- Consolidation of example makefiles to use common build infrastructure
- Addition of CI/CD workflows for testing and examples
- New utility scripts for amalgamation and compilation database generation
- Cleanup of obsolete files and documentation
Reviewed Changes
Copilot reviewed 117 out of 143 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
GNUmakefile |
New root makefile implementing modular build system with recursive package expansion |
share/mk/*.mk |
Build system infrastructure for compilation, testing, and examples |
tests/tests.hpp |
Updated test header to use Catch2 exclusively with inline functions |
tests/main.cpp |
Simplified to only define Catch2 main, removing all test includes |
tests/Makefile |
Converted to use new build system with source listing |
tests/*.cpp |
Removed conditional compilation directives for Catch2 |
examples/*/Makefile |
Standardized to use epw.example.mk |
.github/workflows/*.yml |
Added CI workflows for tests and examples |
script/*.pl |
New Perl scripts for amalgamation and compilation database |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
@olivia-banks I've opened a new pull request, #119, to work on those changes. Once the pull request is ready, I'll request review from you. |
|
Copilot apparently decided it wasn't going to comment on my code. When you get a moment, @gvegayon, would you be willing to give this a provisional review? There's still some work I have to do but the large share is complete. If it's too much we can also discuss the contents of this PR during our next meeting. |
gvegayon
left a comment
There was a problem hiding this comment.
This is looking good, @olivia-banks! I see what you are doing. Besides the comments I already left, it would be nice to ensure that the devcontainer is aligned with these changes.
|
For some reason, |
|
This is a GitHub issue (what!?!?), so I'm holding off on this for now. actions/runner#449 |
|
It looks like GitHub is having some serious issues with their macOS runners, so I'm going to disable them for the time being. Will re-try periodically and re-enable once things mellow out. |
|
@gvegayon I know you typically use dev containers, but how do you run your tests? Do you have an IDE extension where you can run it from the line-counter, or do you do it through the CLI? Want to make sure this is as transparent as possible. |
Running full tests has been |
|
Awesome, I'll get this working. Might not be before Tuesday, things are pretty hectic! |
|
Looks like the macOS runners are back up and running; when we get a cache hit we'll know for certain, but it looks hopeful. Will trigger soon. |
Completely overhaul the build system. Previously, the build logic was scattered, and so was configuration. It was also implemented recursively (
$(MAKE) -C), which hurt parallelism and general performance.Now, the build system logic is very centralized, uses
includewhere-ever possible, and makes defining new tests/examples/et-cetera as easy as possible.More extensive documentation will be included with #97.
This is probably the largest changes required to close #92, maybe on-par with fixing linting and formatting issues.
Some files have been removed that have not been used or touches in ages.