Skip to content

feat: support module_version for add-to-app releases #121

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.

Sign up for GitHub

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

Open
eseidel wants to merge 7 commits into
base: add-build-trace
Choose a base branch
from
+23 −0
Open

feat: support module_version for add-to-app releases #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ece900c
feat: read release_version from shorebird.yaml for add-to-app
eseidel Apr 2, 2026
84bb89d
feat: support SHOREBIRD_RELEASE_VERSION env var in compileShorebirdYaml
eseidel Apr 2, 2026
1b407db
refactor: rename aar_version to module_version
eseidel Apr 2, 2026
bf18fd5
chore: remove accidentally committed files
eseidel Apr 2, 2026
6dfff56
fix: consistent module_version naming and comments
eseidel Apr 2, 2026
8ffafdb
feat: plumb module_version through updater as a separate field
eseidel Apr 2, 2026
57f5ed5
test: add module_version env var test
eseidel Apr 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/flutter_tools/lib/src/shorebird/shorebird_yaml.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,5 +61,9 @@ Map<String, dynamic> compileShorebirdYaml(YamlMap yamlMap, {required String? fla
if (shorebirdPublicKeyEnvVar != null) {
compiled['patch_public_key'] = shorebirdPublicKeyEnvVar;
}
final String? moduleVersion = environment['SHOREBIRD_MODULE_VERSION'];
if (moduleVersion != null) {
compiled['module_version'] = moduleVersion;
}
return compiled;
}
19 changes: 19 additions & 0 deletions packages/flutter_tools/test/general.shard/shorebird/shorebird_yaml_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,25 @@ patch_verification: strict
'patch_public_key': '4-a',
});
});
test('module_version from environment', () {
const String yamlContents = '''
app_id: 1-a
''';
final YamlDocument input = loadYamlDocument(yamlContents);
final YamlMap yamlMap = input.contents as YamlMap;

// Without env var, module_version is absent.
final Map<String, dynamic> withoutEnv =
compileShorebirdYaml(yamlMap, flavor: null, environment: <String, String>{});
expect(withoutEnv.containsKey('module_version'), isFalse);

// With env var, module_version is included.
final Map<String, dynamic> withEnv =
compileShorebirdYaml(yamlMap, flavor: null, environment: <String, String>{
'SHOREBIRD_MODULE_VERSION': 'abc1234',
});
expect(withEnv['module_version'], 'abc1234');
});
test('edit in place', () {
const String yamlContents = '''
app_id: 1-a
Expand Down
Loading