-
Notifications
You must be signed in to change notification settings - Fork 22
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
🧱 Include MQT Core via FetchContent instead as submodule #455
Conversation
This PR will only pass all test when a new release of MQT Core is build that contains the Neutral Atom Support. The version number is already incremented accordingly. If this is not desired, the last commit can also be reverted to reference the appropriate commit directly. |
As far as I can see, this is also related to #418, and realises a part of it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In principle, I am in favour of just merging this. There is one corner case, that gets worse with this change though: By not providing the submodule fallback, any initial build from a fresh clone will require internet access, i.e., it is no longer possible to build the project without network connection given a fresh clone.
In the long run, this shouldn't be an issue for the Python side of things once #418 is in since mqt-core will then be a build and runtime dependency and, as a result, always be available when installing the Python package.
For the C++-only side of the project, it might not be that clean. Sure, people could start installing mqt-core on their systems and then use the find_package
part of FetchContent to get that version. This is probably what most packagers would do if they ever where to package our tools for things like FreeBSD, homebrew, conda-forge, etc.
None of the above is opposing this change. I just wanted to put this out there to spread awareness. I just triggered a new mqt-core release, which will be 2.5.0
.
Co-authored-by: Lukas Burgholzer <burgholzer@me.com>
Another small drawback that I just noticed is that we kind of loose the automatic dependency updates (i.e., dependabot) for keeping the submodule up to date. But maybe this isn't too important as updates of mqt-core should be driven by demand anyways. |
I just thought about this a little more. I think I would be fine with dropping the offline installation possibility given the fact that, this is hardly possible at the moment anyways since mqt-core also uses I'd still like to keep the automatic updates though. However, it should be possible to write a rather simple GitHub workflow that periodically checks for new releases of |
# Conflicts: # extern/mqt-core
this allows to easily point fetch content to a branch or a simply a specific commit. `MQT_CORE_REV` can be anything from - `origin/branch-name` - `v2.5.0` or `v${MQT_CORE_VERSION}` - `0e4ff9e0521886449027b252c65913e1afa863b0` Signed-off-by: burgholzer <burgholzer@me.com>
since `MQT_CORE_REV` is a commit hash past the `v2.5.0` release, the appropriate version is `2.5.1`. Going forward, it should be ensured that the commit hash and the version always work together, i.e., switching the `rev` might also necessitate updating the version. Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alright. This is ready to go in ✅
Let's see how long it takes until the auto update workflow breaks 😅
Description
MQT Core was included as a submodule so far. This PR removes this submodule and uses the existing fetch content commands to include this dependency.
Furthermore, it adds a dependabot-like update workflow for the FetchContent-managed mqt-core dependency.
Checklist: