Merge pull request #107 from skyeskie/auto_version

Automatically use Pubspec version number as basis for MSIX version

Author: YehudaKremer

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 3.2.0
+
+- Automatically use the Pubspec `version` tag by default. To use auto-versioning, remove any `msix_version` fields or command line options.
+
 ## 3.1.6
 
 ### Breaking Changes

README.md

@@ -51,6 +51,7 @@ msix_config:
   logo_path: C:\path\to\logo.png
   capabilities: internetClient, location, microphone, webcam
 ```
+See [Configurations Examples And Use Cases].
 
 ### Available Configurations
 
@@ -126,7 +127,27 @@ msix_config:
 
 </details>
 
-See also [Configurations Examples And Use Cases].
+### Msix Version
+
+The MSIX installer version number is used to determine updates to the app and consists of 4 numbers (`1.0.0.0`).
+
+<details>
+
+<summary>See more details on how to set the msix version (click to expand)</summary>
+
+#### The version is determined by the first available option:
+
+1. Command line `--version` flag
+2. In `pubspec.yaml`, under the `msix_config` node, the `msix_version` value
+3. Using the `version` field in `pubspec.yaml`.
+   - The Pubspec version uses [semver], which is of the form `major.minor.patch-prerelease+build`
+   - `msix` will use the `major.minor.patch` and append a `0` for the MSIX version
+   - All prerelease and build info is discarded
+4. Fallback to `1.0.0.0`
+
+By default, if you have a valid `version` in your `pubspec.yaml` file, that will form the basis for your MSIX installer version.
+
+</details>
 
 ## :black_nib: Signing options
 
@@ -227,4 +248,4 @@ Tags: `msi` `windows` `win10` `win11` `windows10` `windows11` `windows store` `w
 [disabled]: https://docs.microsoft.com/en-us/windows/msix/app-installer/installing-windows10-apps-web
 [self signed]: https://docs.microsoft.com/en-us/windows/msix/package/create-certificate-package-signing#create-a-self-signed-certificate
 [Configurations Examples And Use Cases]: https://pub.dev/packages/msix/example
-
+[semver]: https://semver.org/

example/README.md

@@ -34,11 +34,16 @@ msix_config:
 ###### For CI/CD:
 
 ```yaml
+name: flutter_app
+version: 1.3.2
+
+# ...
+
 msix_config:
   display_name: Flutter App
-  msix_version: 1.0.1.0
   install_certificate: false
 ```
+Note: The main app version will be used as a basis for the MSIX version (`1.3.2` to `1.3.2.0`)
 
 ###### With Metadata:
 

lib/src/configuration.dart

@@ -3,6 +3,7 @@ import 'package:args/args.dart' show ArgParser, ArgResults;
 import 'package:cli_util/cli_logging.dart' show Logger;
 import 'package:package_config/package_config.dart' show findPackageConfig;
 import 'package:path/path.dart' show extension, basename;
+import 'package:pub_semver/pub_semver.dart';
 import 'package:yaml/yaml.dart' show YamlMap, loadYaml;
 import 'extensions.dart';
 
@@ -68,7 +69,8 @@ class Configuration {
     appName = pubspec['name'];
     appDescription = pubspec['description'];
     var yaml = pubspec['msix_config'] ?? YamlMap();
-    msixVersion = _args['version'] ?? yaml['msix_version'];
+    msixVersion =
+        _args['version'] ?? yaml['msix_version'] ?? _getPubspecVersion(pubspec);
     certificatePath = _args['certificate-path'] ?? yaml['certificate_path'];
     certificatePassword = _args['certificate-password'] ??
         yaml['certificate_password']?.toString();
@@ -334,6 +336,25 @@ class Configuration {
     return pubspec;
   }
 
+  String? _getPubspecVersion(dynamic yaml) {
+    // Existing behavior is to put null if no version, so matching
+    if (yaml['version'] == null) return null;
+    try {
+      final pubspecVersion = Version.parse(yaml['version']);
+      return [
+        pubspecVersion.major,
+        pubspecVersion.minor,
+        pubspecVersion.patch,
+        0
+      ].join('.');
+    } on FormatException {
+      _logger.stderr(
+        'Warning: Could not parse Pubspec version. No version provided.',
+      );
+      return null;
+    }
+  }
+
   /// Get the languages list
   Iterable<String>? _getLanguages(dynamic config) =>
       ((_args['languages'] ?? config['languages']) as String?)

pubspec.yaml

@@ -1,6 +1,6 @@
 name: msix
 description: A command-line tool that create Msix installer from your flutter windows-build files.
-version: 3.1.6
+version: 3.2.0
 maintainer: Yehuda Kremer (yehudakremer@gmail.com)
 homepage: https://github.com/YehudaKremer/msix
 

test/configuration_test.dart

@@ -123,6 +123,41 @@ msix_config:
       await customConfig.getConfigValues();
       expect(config.msixVersion, isNull);
     });
+
+    test('fallback to pubspec version', () async {
+      await File(yamlTestPath).writeAsString(
+        'name: testAppWithVersion\n'
+        'version: 1.1.3',
+      );
+      await config.getConfigValues();
+      expect(config.msixVersion, equals('1.1.3.0'));
+    });
+
+    test('ignores extra semver info in pubspec version', () async {
+      await File(yamlTestPath).writeAsString(
+        'name: testAppWithVersion\n'
+        'version: 0.8.13-alpha.1+2000-01-01',
+      );
+      await config.getConfigValues();
+      expect(config.msixVersion, equals('0.8.13.0'));
+    });
+
+    test('puts version null on invalid semver', () async {
+      await File(yamlTestPath).writeAsString(
+        'name: invalidSemverApp\n'
+        'version: 0.8.13a',
+      );
+      await config.getConfigValues();
+      expect(config.msixVersion, isNull);
+    });
+
+    test('no version provided - null then maps to 1.0.0.0', () async {
+      await File(yamlTestPath).writeAsString(yamlContent);
+      await config.getConfigValues();
+      expect(config.msixVersion, isNull);
+      await config.validateConfigValues();
+      expect(config.msixVersion, equals('1.0.0.0'));
+    });
   });
 
   group('certificate:', () {