Fix incorrect Version metadata in dist-info #124
+8
−8
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closes OpenAssetIO#123. The CMake script has the ability to simulate a Python package installation, such that a `dist-info` metadata directory is installed alongside the package, effectively preventing accidental overwrite by other package managers (e.g. pip) when the project is installed via CMake - see OpenAssetIO#58. However, the `Version` field in the `METADATA` file that forms part of the Python package `dist-info` was not being properly filled in. This was not caught by CI because the test for it is only enabled if generation of Python traits via CMake is enabled (i.e. `OPENASSETIO_MEDIACREATION_GENERATE_PYTHON`), which was not the case for the "test" CMake preset used by the "Test Cpp" CI job. There was another problem with running the test, in that the PYTHONPATH was not properly set in the CMake test target, and so the test would not necessarily be able to locate the `openassetio-mediacreation` package installed by CMake. Signed-off-by: David Feltell <david.feltell@foundry.com>
Member
Author
|
MacOS CI is failing pending #125 |
feltech
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #123.
The CMake script has the ability to simulate a Python package installation, such that a
dist-infometadata directory is installed alongside the package, effectively preventing accidental overwrite by other package managers (e.g. pip) when the project is installed via CMake - see #58.However, the
Versionfield in theMETADATAfile that forms part of the Python packagedist-infowas not being properly filled in.This was not caught by CI because the test for it is only enabled if generation of Python traits via CMake is enabled (i.e.
OPENASSETIO_MEDIACREATION_GENERATE_PYTHON), which was not the case for the "test" CMake preset used by the "Test Cpp" CI job.There was another problem with running the test, in that the PYTHONPATH was not properly set in the CMake test target, and so the test would not necessarily be able to locate the
openassetio-mediacreationpackage installed by CMake.