Notes! (formerly KSP_notes)

Notes! (formerly KSP_notes)

1.1k Downloads

Duplicate version file

HebaruSan opened this issue ยท 6 comments

commented

0.17.0.0 failed to be added to CKAN because it has two copies of its version file:

image

image

They're identical except for the NAME, as far as I can tell. Suggest removing notesRPM.version to fix this, as it doesn't look like it's needed.

Tagging @zer0Kerbal to make sure GItHub sends notifications.

commented

Thank you. Kindly read contributiing.md, code_of_conduct.md and styleguide.md. These are boilerplate.

commented

Thank you for taking your extremely valuable time to report this issue @HebaruSan

Ithere are two .dll's, both different in each release.

One .version file per .dll. That is all.

commented

Version files live at the mod level, not the DLL level. One mod with two DLLs should have one version file.

commented

@zer0Kerbal, I'm sorry that I reacted that way; I woke up feeling irritable today (sirens speeding past the house can do that) and I should not have taken that out on you. You do deserve better. I'll delete that comment.

Aside from tone problems, though, this is reporting a valid problem. Version files are not supposed to be one-per-DLL; they're meant to represent the compatibility of an entire mod, and there's no benefit from duplicating them, and in fact it could cause problems down the line. To see why, think about what would happen if you changed the KSP_VERSION_MIN of one file and the KSP_VERSION_MAX of the other file; now that they're out of sync, what is the "true" comptibility of the mod? It's not in either file, but rather has to be interpreted by combining both files somehow. If CKAN looks to just one of the files to represent the compatibility of this mod, it could well end up with incorrect metadata. Last but not least, it adds an extra maintenance burden and opportunity for errors.

I care about this because I don't want to see extra/redundant version files proliferating through a bunch more mods; better to nip it in the bud now.

Please consider fixing this. Thanks!

commented

@zer0Kerbal, I'm sorry that I reacted that way; I woke up feeling irritable today (sirens speeding past the house can do that) and I should not have taken that out on you. You do deserve better. I'll delete that comment.

As did I. Plus the don't give credit stuck in my sleep deprived craw. I always go out of my way to properly credit, unless I am told in writing in advance, which let's face it - that won't happen.

Aside from tone problems, though, this is reporting a valid problem. Version files are not supposed to be one-per-DLL; they're meant to represent the compatibility of an entire mod, and there's no benefit from duplicating them, and in fact it could cause problems down the line. To see why, think about what would happen if you changed the KSP_VERSION_MIN of one file and the KSP_VERSION_MAX of the other file; now that they're out of sync, what is the "true" comptibility of the mod? It's not in either file, but rather has to be interpreted by combining both files somehow. If CKAN looks to just one of the files to represent the compatibility of this mod, it could well end up with incorrect metadata. Last but not least, it adds an extra maintenance burden and opportunity for errors.

I care about this because I don't want to see extra/redundant version files proliferating through a bunch more mods; better to nip it in the bud now.

Please consider fixing this. Thanks!

A new version has dropped on SpaceDock - it still is 0.17.0.0 but now with -adoption added - so it doesn't mess up the versioning for other releases.

Thank you for bringing this to my attention. Proper credit will be given next release. ;p

commented

Cool, that worked! ๐ŸŽ‰

KSP-CKAN/CKAN-meta@a36b018