kbin-kes icon indicating copy to clipboard operation
kbin-kes copied to clipboard

[FEAT] Increment version in mod manifest

Open aclist opened this issue 10 months ago • 0 comments

Browser

Firefox-based

Script manager

Tampermonkey

KES version

4.3.0-beta.36

Describe the feature

Keeping version numbers in mod manifests up to date can be difficult because:

  • A mod may see several hotfixes in a short period of time
  • The author has to remember to manually update this field

One approach would be to use the conventional commits in the log to check for major, minor, or patch updates to atomic mods, and update the version accordingly in build scripts. But this is still prone to error, because the committer still has to remember to include this parenthetical information.

To get around all of this, maybe using a discrete checksum for the current file and eschewing the human readable version number would work: during the build process, the script can check if the hash in the manifest matches the one derived from the mod file. If it doesn't, the script can update the JSON in-place in the mod's subdirectory, and then use these updated manifests to compile the global manifest. So the "version" would now be tied to a unique checksum ID which can be referenced in the future.

Authors also wouldn't need to touch this field, since it would be updated automatically when building.

aclist avatar Feb 22 '25 14:02 aclist