feat: add pre-release prefix option for versioning

Author: flxapps

.github/workflows/pr_workflow.yaml

@@ -6,6 +6,10 @@ on:
         type: boolean
         description: "Whether to run the version command with the pre-release flag"
         default: false
+      pre_release_prefix:
+        type: string
+        description: "Prefix for pre-release versions (e.g. 'dev' => 3.0.0-dev.1, empty => 3.0.0-1)"
+        default: ""
       use_local_version:
         type: boolean
         description: "Whether to use the local version of mtrust_api_guard"
@@ -36,7 +40,7 @@ jobs:
         run: dart pub global activate --source path .
       - name: Compare API changes
         id: version
-        run: mtrust_api_guard version --badge --no-commit --tag --generate-changelog --json version_output.json  ${{ inputs.pre_release && '--pre-release' || '' }}
+        run: mtrust_api_guard version --badge --no-commit --tag --generate-changelog --json version_output.json ${{ inputs.pre_release && '--pre-release' || '' }} ${{ inputs.pre_release_prefix != '' && format('--pre-release-prefix "{0}"', inputs.pre_release_prefix) || '' }}
 
       - name: Generate version summary and comment on PR
         if: github.event_name == 'pull_request'

lib/version/calculate_next_version.dart

@@ -11,6 +11,7 @@ Future<String> calculateNextVersion(
   bool isPreRelease,
   Directory gitRoot,
   String tagPrefix,
+  String preReleasePrefix,
 ) async {
   logger.info('Current version: $version');
 
@@ -37,12 +38,22 @@ Future<String> calculateNextVersion(
   logger.info('New version: $newVersion');
 
   if (isPreRelease) {
+    final normalizedPrefix = preReleasePrefix.trim();
+    final separator = normalizedPrefix.isEmpty || normalizedPrefix.endsWith('.') ? '' : '.';
+    String buildPreReleaseSuffix(int number) {
+      if (normalizedPrefix.isEmpty) {
+        return '$number';
+      }
+      return '$normalizedPrefix$separator$number';
+    }
+
     var preReleaseNum = 1;
-    while (await GitUtils.gitTagExists('$tagPrefix$newVersion-dev.$preReleaseNum', gitRoot.path)) {
+    while (await GitUtils.gitTagExists('$tagPrefix$newVersion-${buildPreReleaseSuffix(preReleaseNum)}', gitRoot.path)) {
       preReleaseNum++;
     }
-    logger.info('Pre-release version: $newVersion-dev.$preReleaseNum');
-    return '$newVersion-dev.$preReleaseNum';
+    final preReleaseVersion = '$newVersion-${buildPreReleaseSuffix(preReleaseNum)}';
+    logger.info('Pre-release version: $preReleaseVersion');
+    return preReleaseVersion;
   } else if (await GitUtils.gitTagExists('$tagPrefix$newVersion', gitRoot.path)) {
     logger.err('Version tag $tagPrefix$newVersion already exists');
     throw Exception('Version tag $tagPrefix$newVersion already exists');

lib/version/version.dart

@@ -43,6 +43,7 @@ Future<VersionResult> version({
   required bool tag,
   String? newRef,
   required bool isPreRelease,
+  required String preReleasePrefix,
   required bool commit,
   required bool badge,
   required bool generateChangelog,
@@ -106,8 +107,14 @@ Future<VersionResult> version({
 
   // For workspace packages, extract the 'v' prefix from tagPrefix (which is like 'package/v')
   final versionTagPrefix = packageName != null ? 'v' : tagPrefix;
-  final nextVersion =
-      await calculateNextVersion(baseVersion, highestMagnitudeChange, isPreRelease, gitRoot, versionTagPrefix);
+  final nextVersion = await calculateNextVersion(
+    baseVersion,
+    highestMagnitudeChange,
+    isPreRelease,
+    gitRoot,
+    versionTagPrefix,
+    preReleasePrefix,
+  );
 
   logger.info('Next version: $nextVersion');
 

lib/version/version_command.dart

@@ -60,9 +60,15 @@ class VersionCommand extends Command
       ..addFlag(
         'pre-release',
         abbr: 'p',
-        help: 'Add pre-release suffix. 3.0.0-dev.1 where dev.1 is the pre-release suffix',
+        help: 'Add pre-release suffix. Defaults to 3.0.0-1 unless --pre-release-prefix is provided',
         defaultsTo: false,
       )
+      ..addOption(
+        'pre-release-prefix',
+        help: 'Prefix for pre-release versions. Example: --pre-release-prefix dev -> 3.0.0-dev.1',
+        defaultsTo: '',
+        valueHelp: 'prefix',
+      )
       ..addOption(
         'tag-prefix',
         help: 'Prefix for version tags useful for mono repos where multiple packages are versioned together',
@@ -88,6 +94,10 @@ class VersionCommand extends Command
     return argResults?['pre-release'] as bool;
   }
 
+  String get preReleasePrefix {
+    return argResults?['pre-release-prefix'] as String? ?? '';
+  }
+
   bool get badge {
     return argResults?['badge'] as bool;
   }
@@ -122,6 +132,7 @@ class VersionCommand extends Command
       generateChangelog: generateChangelog,
       cache: cache,
       isPreRelease: preRelease,
+      preReleasePrefix: preReleasePrefix,
       tagPrefix: tagPrefix,
       dartFile: dartFile,
     );

lib/version/version_workspace_command.dart

@@ -18,7 +18,8 @@ class VersionWorkspaceCommand extends Command
   factory VersionWorkspaceCommand() => _instance;
 
   @override
-  String get description => "Calculate and output the next version for all packages in a workspace based on API changes";
+  String get description =>
+      "Calculate and output the next version for all packages in a workspace based on API changes";
 
   @override
   String get name => "version-workspace";
@@ -64,9 +65,15 @@ class VersionWorkspaceCommand extends Command
       ..addFlag(
         'pre-release',
         abbr: 'p',
-        help: 'Add pre-release suffix. 3.0.0-dev.1 where dev.1 is the pre-release suffix',
+        help: 'Add pre-release suffix. Defaults to 3.0.0-1 unless --pre-release-prefix is provided',
         defaultsTo: false,
       )
+      ..addOption(
+        'pre-release-prefix',
+        help: 'Prefix for pre-release versions. Example: --pre-release-prefix dev -> 3.0.0-dev.1',
+        defaultsTo: '',
+        valueHelp: 'prefix',
+      )
       ..addOption(
         'dart-file',
         help: 'Output the version as a Dart constant to the specified file',
@@ -86,6 +93,10 @@ class VersionWorkspaceCommand extends Command
     return argResults?['pre-release'] as bool;
   }
 
+  String get preReleasePrefix {
+    return argResults?['pre-release-prefix'] as String? ?? '';
+  }
+
   bool get badge {
     return argResults?['badge'] as bool;
   }
@@ -128,6 +139,7 @@ class VersionWorkspaceCommand extends Command
       generateChangelog: generateChangelog,
       cache: cache,
       isPreRelease: preRelease,
+      preReleasePrefix: preReleasePrefix,
       dartFile: dartFile,
     );
 

lib/version/workspace_version.dart

@@ -32,6 +32,7 @@ Future<WorkspaceVersionResult> versionWorkspace({
   required bool tag,
   String? newRef,
   required bool isPreRelease,
+  required String preReleasePrefix,
   required bool commit,
   required bool badge,
   required bool generateChangelog,
@@ -83,6 +84,7 @@ Future<WorkspaceVersionResult> versionWorkspace({
         tag: tag,
         newRef: effectiveNewRef,
         isPreRelease: isPreRelease,
+        preReleasePrefix: preReleasePrefix,
         commit: commit,
         badge: badge,
         generateChangelog: generateChangelog,

test/commands/version_command_test.dart

@@ -326,21 +326,37 @@ void main() {
       await testSetup.commitChanges('API change to v${TestConstants.minorVersion}');
 
       await testSetup.runApiGuard('version', ['--pre-release']);
-      expect(testSetup.getCurrentVersion(), '0.1.0-dev.1');
+      expect(testSetup.getCurrentVersion(), '0.1.0-1');
 
       // 3. Apply major changes and create another pre-release
       await copyDir(testSetup.fixtures.appV200Dir, testSetup.tempDir);
       await testSetup.commitChanges('feat: implement compatibility with v${TestConstants.majorVersion}');
 
       await testSetup.runApiGuard('version', ['--pre-release']);
-      expect(testSetup.getCurrentVersion(), '1.0.0-dev.1');
+      expect(testSetup.getCurrentVersion(), '1.0.0-1');
 
       // 4. Finalize the release (removes pre-release suffix)
       await testSetup.runApiGuard('version', []);
 
       expect(testSetup.getCurrentVersion(), '1.0.0');
     });
 
+    test('pre-release prefix option applies custom suffix', () async {
+      // 1. Set up initial tagged version
+      await testSetup.setupGitRepo();
+      await testSetup.setupFlutterPackage();
+      await copyDir(testSetup.fixtures.appV100Dir, testSetup.tempDir);
+      await testSetup.commitChanges('chore!: Initial release v${TestConstants.initialVersion}');
+      await runProcess('git', ['tag', 'v${TestConstants.initialVersion}'], workingDir: testSetup.tempDir.path);
+
+      // 2. Apply minor changes and create pre-release with custom prefix
+      await copyDir(testSetup.fixtures.appV110Dir, testSetup.tempDir);
+      await testSetup.commitChanges('API change to v${TestConstants.minorVersion}');
+
+      await testSetup.runApiGuard('version', ['--pre-release', '--pre-release-prefix', 'dev']);
+      expect(testSetup.getCurrentVersion(), '0.1.0-dev.1');
+    });
+
     test('custom tag prefix works correctly', () async {
       // 1. Set up initial tagged version with custom prefix
       await testSetup.setupGitRepo();