Merge pull request #35 from taj54/feature/multi-file-version-update

feat(version-bump): add custom version bump targets

Author: taj54

action.yml

@@ -22,7 +22,14 @@ inputs:
     description: 'The target path where the version bump should be applied. If not provided, the action will run in the root directory.'
     required: false
     default: '.'
-
+  bump_targets:
+    description: |
+      Optional list of version update targets.
+      Provide the `path` and the `variable` to update, the Action will build regex automatically.
+      Example:
+      '[{"path": "setup.py", "variable": "version"}, {"path": "Dockerfile", "variable": "APP_VERSION"}]'
+    required: false
+    default: '[]'
 outputs:
   new_version:
     description: 'The new bumped version'

dist/index.js.map

@@ -5,3 +5,4 @@ export const RELEASE_TYPE = (core.getInput('release_type') || 'patch') as semver
 export const TARGET_PLATFORM = core.getInput('target_platform');
 export const GIT_TAG = core.getInput('git_tag') === 'true';
 export const TARGET_PATH = core.getInput('target_path') || '.';
+export const BUMP_TARGETS = JSON.parse(core.getInput('bump_targets') || '[]');

src/config/index.ts

@@ -1,13 +1,14 @@
 import { UpdaterService, GitService, ChangelogService } from './services';
-import { FileHandler } from './utils';
+import { FileHandler, safeParseJSON } from './utils';
 import { UpdaterRegistry } from './registry';
 import {
   PlatformDetectionError,
   VersionBumpError,
   FileNotFoundError,
   InvalidManifestError,
 } from './errors';
-import { RELEASE_TYPE, TARGET_PLATFORM, GIT_TAG, TARGET_PATH } from './config';
+import { RELEASE_TYPE, TARGET_PLATFORM, GIT_TAG, TARGET_PATH, BUMP_TARGETS } from './config';
+
 import * as core from '@actions/core';
 
 async function initializeServices() {
@@ -37,7 +38,8 @@ async function run() {
     const platform = updaterService.getPlatform(targetPlatform);
     core.info(`Detected platform: ${platform}`);
 
-    const version = updaterService.updateVersion(platform, releaseType);
+    const bumpTargets = safeParseJSON<{ path: string; variable: string }[]>(BUMP_TARGETS);
+    const version = updaterService.updateVersion(platform, releaseType, bumpTargets);
     core.setOutput('new_version', version);
 
     // Generate and update changelog

src/index.ts

@@ -1,6 +1,7 @@
 import semver from 'semver';
 import { PlatformDetectionError, VersionBumpError } from '../errors';
 import { UpdaterRegistry } from '../registry/updaterRegistry';
+import { CustomUpdater } from '../updaters/customUpdater';
 
 /**
  * Service for managing version updates.
@@ -47,11 +48,27 @@ export class UpdaterService {
    * @param releaseType The type of release (major, minor, patch).
    * @returns The new version string.
    */
-  updateVersion(platform: string, releaseType: semver.ReleaseType): string {
-    const updater = this.updaterRegistry.getUpdater(platform);
-    if (!updater) {
-      throw new VersionBumpError(`No updater found for platform: ${platform}`);
+  updateVersion(
+    platform: string,
+    releaseType: semver.ReleaseType,
+    bumpTargets: Array<{ path: string; variable: string }> = [],
+  ): string {
+    if (platform === 'custom') {
+      if (bumpTargets.length === 0) {
+        throw new VersionBumpError('No bump_targets provided for custom platform.');
+      }
+      let lastBumpedVersion: string = '';
+      for (const target of bumpTargets) {
+        const customUpdater = new CustomUpdater(target.path, target.variable);
+        lastBumpedVersion = customUpdater.bumpVersion(releaseType);
+      }
+      return lastBumpedVersion;
+    } else {
+      const updater = this.updaterRegistry.getUpdater(platform);
+      if (!updater) {
+        throw new VersionBumpError(`No updater found for platform: ${platform}`);
+      }
+      return updater.bumpVersion(releaseType);
     }
-    return updater.bumpVersion(releaseType);
   }
 }

src/services/updaterService.ts

@@ -0,0 +1,65 @@
+import type { ReleaseType } from 'semver';
+import { UpdaterInterface } from '../interface/updaterInterface';
+import * as core from '@actions/core';
+import { calculateNextVersion, FileHandler, ManifestParser } from '../utils';
+
+export class CustomUpdater implements UpdaterInterface {
+  platform = 'custom';
+  private filePath: string;
+  private variableName: string;
+  private currentVersion: string | null = null;
+  private fileHandler: FileHandler;
+  private manifestParser: ManifestParser;
+
+  constructor(filePath: string, variableName: string) {
+    this.filePath = filePath;
+    this.variableName = variableName;
+    this.fileHandler = new FileHandler();
+    this.manifestParser = new ManifestParser(this.fileHandler);
+  }
+
+  canHandle(): boolean {
+    // This updater is explicitly called, so it can always handle if constructed.
+    return true;
+  }
+
+  getCurrentVersion(): string | null {
+    if (this.currentVersion) {
+      return this.currentVersion;
+    }
+
+    try {
+      // eslint-disable-next-line no-useless-escape
+      const regex = new RegExp(`(${this.variableName}\s*=\s*['"]?)([\\d.]+)(['"]?)`);
+      this.currentVersion = this.manifestParser.getVersion(this.filePath, 'regex', {
+        regex: regex,
+      });
+      return this.currentVersion;
+    } catch (error) {
+      core.debug(`Could not read or parse version from ${this.filePath}: ${error}`);
+    }
+    return null;
+  }
+
+  bumpVersion(releaseType: ReleaseType): string {
+    const oldVersion = this.getCurrentVersion();
+    if (!oldVersion) {
+      throw new Error(
+        `Could not find current version for variable '${this.variableName}' in file '${this.filePath}'`,
+      );
+    }
+
+    const newVersion = calculateNextVersion(oldVersion, releaseType);
+    // eslint-disable-next-line no-useless-escape
+    const regexReplace = new RegExp(`(${this.variableName}\s*=\s*['"]?)${oldVersion}(['"]?)`);
+
+    this.manifestParser.updateVersion(this.filePath, newVersion, 'regex', {
+      regexReplace: regexReplace,
+    });
+
+    core.info(
+      `Bumped ${this.variableName} in ${this.filePath} from ${oldVersion} to ${newVersion}`,
+    );
+    return newVersion;
+  }
+}

src/updaters/customUpdater.ts

@@ -1,3 +1,4 @@
 export * from './versionUtil';
 export * from './fileHandler';
 export * from './manifestParser';
+export * from './jsonUtils';

src/utils/index.ts

@@ -0,0 +1,16 @@
+/**
+ * Safely parses a JSON string.
+ * Returns null (or a fallback) if parsing fails or input is invalid.
+ */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+export function safeParseJSON<T>(str: string | undefined | null): T | undefined {
+  try {
+    if (!str || typeof str !== 'string' || str.trim() === '') {
+      return undefined;
+    }
+    return JSON.parse(str) as T;
+  } catch (e) {
+    console.error('Invalid JSON:', e);
+    return undefined;
+  }
+}