feat: plumb module_version through as a separate field#329
Open
feat: plumb module_version through as a separate field#329
Conversation
eseidel
commented
Apr 2, 2026
Add module_version as an optional field through the full updater stack: - YamlConfig: parse module_version from shorebird.yaml - UpdateConfig: propagate module_version from yaml config - PatchCheckRequest: send module_version alongside release_version (skipped when null via serde skip_serializing_if) The server uses module_version for patch lookup when present, while release_version always contains the host app's version for analytics. This avoids polluting release_version data with git hashes from module releases. Part of shorebirdtech/shorebird#793
3dbf8f0 to
76a7912
Compare
This was referenced Apr 2, 2026
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
module_version: Option<String>toYamlConfig(parsed from shorebird.yaml)UpdateConfigtoPatchCheckRequestrelease_version(skipped when null viaserde(skip_serializing_if))Context
Part of shorebirdtech/shorebird#793
Instead of overriding
release_versionwith the module version, we plumbmodule_versionas a separate optional field. This keepsrelease_versionas the host app's version (for analytics) whilemodule_versionis used for patch lookup.Companion PRs:
Test plan