Add the ability to add substitutions to project versions

Author: ryanjbaxter

.github/actions/update-project-versions/README.md

@@ -26,6 +26,7 @@ The following directories are always skipped: `.git`, `node_modules`, `target`,
 | `versions` | ✴️ | — | JSON object mapping project names to versions (e.g. `{"spring-boot":"3.2.3","spring-cloud-config":"4.1.1"}`). Typically produced by the `extract-bom-versions` action. Required when `release-train-version` is not set. |
 | `project-version` | ✴️ | — | The new version for this project (e.g. `4.1.2`). Used to update the root `pom.xml` `<version>`, child `<parent><version>` when the parent is the root project, the bare `version=` in `gradle.properties`, and the `version = '...'` line in `build.gradle`. Required when `release-train-version` is not set. |
 | `directory` | ❌ | `.` | Root directory of the project to update. Defaults to the repository root. |
+| `project-version-substitutions` | ❌ | — | JSON object mapping additional version property name prefixes to project names already in the versions map. Only used with `release-train-version`. See [Version name substitutions](#version-name-substitutions). |
 
 ✴️ Either `release-train-version` **or** both `versions` and `project-version` must be supplied.
 
@@ -137,6 +138,24 @@ Property keys follow the camelCase convention used by Spring Cloud projects:
 
 Only keys matching the pattern `^[a-zA-Z0-9]+Version$` (a camelCase prefix immediately followed by `Version`) are considered. Keys like `releaseVersion` or `versionCode` are intentionally ignored.
 
+## Version name substitutions
+
+Some projects use version property names that don't follow the standard camelCase-to-kebab-case convention. The `project-version-substitutions` input lets you bridge these non-standard names to the correct project entry in the versions map.
+
+For example, `spring-cloud-contract` uses `verifierVersion` in its `gradle.properties` instead of the expected `springCloudContractVersion`. The camelCase-to-kebab conversion of `verifier` is just `verifier`, which has no entry in the versions map. To fix this, pass:
+
+```yaml
+- name: Update project versions
+  uses: spring-cloud/spring-cloud-github-actions/.github/actions/update-project-versions@main
+  with:
+    release-train-version: '2025.1.0'
+    project-version-substitutions: '{"verifier":"spring-cloud-contract"}'
+```
+
+This adds a synthetic `verifier` entry to the versions map with the same version as `spring-cloud-contract`, so `verifierVersion` in `gradle.properties` is updated correctly.
+
+The format is `{"<property-prefix>": "<existing-project-name>"}`. The value must be a key already present in the parsed versions map; unknown values are silently ignored. This input is only used when `release-train-version` is set.
+
 ## Example — Maven multi-module project
 
 Given a `versions` map of `{"spring-boot":"3.2.3","spring-cloud-commons":"4.1.1"}` and `project-version` of `4.1.2`:
@@ -228,3 +247,17 @@ npm run build
 git add dist/index.js dist/licenses.txt
 git commit -m "rebuild dist"
 ```
+
+### Testing Locally
+
+You can run node script for this action against a project checked out locally on your machine.  Here is an example:
+
+```bash
+env \
+  'INPUT_RELEASE-TRAIN-VERSION=2025.1.0' \
+  INPUT_DIRECTORY=/git-repos/spring-cloud/spring-cloud-contract \
+  GITHUB_OUTPUT=/dev/null \
+  GITHUB_ENV=/dev/null \
+  'INPUT_PROJECT-VERSION-SUBSTITUTIONS={"verifier":"spring-cloud-contract", "boot":"spring-boot"}' \
+  node src/index.js
+```

.github/actions/update-project-versions/__tests__/fixtures/gradle-project/gradle.properties

@@ -2,6 +2,9 @@ version=3.1.0
 springBootVersion=3.2.2
 springCloudCommonsVersion=4.1.0
 springCloudBusVersion=4.1.0
+springCloudContractVersion=4.1.0-SNAPSHOT
+verifierVersion=4.1.0-SNAPSHOT
+bootVersion=3.2.2
 # not a Version key — should be ignored
 someOtherProperty=foobar
 # also not matched

.github/actions/update-project-versions/__tests__/fixtures/releaser-config/2024_1_0.properties

@@ -0,0 +1,4 @@
+releaser.fixed-versions[spring-boot]=3.2.3
+releaser.fixed-versions[spring-cloud-bus]=4.1.1
+releaser.fixed-versions[spring-cloud-commons]=4.1.1
+releaser.fixed-versions[spring-cloud-contract]=4.1.1

.github/actions/update-project-versions/__tests__/index.test.js

@@ -140,11 +140,12 @@ describe('replacePropertyValue', () => {
 // ── updateGradlePropertiesContent ─────────────────────────────────────────────
 
 describe('updateGradlePropertiesContent', () => {
-  const versions = {
-    'spring-boot': '3.2.3',
-    'spring-cloud-commons': '4.1.1',
-    'spring-cloud-bus': '4.1.1',
-  };
+  const content = loadFixture('releaser-config', '2024_1_0.properties');
+  const substitutions = {
+    'verifier': 'spring-cloud-contract',
+    'boot': 'spring-boot'
+  }
+  const versions = parseReleaserConfig(content, substitutions);
   const projectVersion = '3.1.1';
 
   let result;
@@ -165,6 +166,10 @@ describe('updateGradlePropertiesContent', () => {
     expect(result.updated).toMatch(/^springBootVersion=3\.2\.3$/m);
     expect(result.updatedProperties).toContain('springBootVersion: 3.2.3');
   });
+  it('updates bootVersion', () => {
+    expect(result.updated).toMatch(/^bootVersion=3\.2\.3$/m);
+    expect(result.updatedProperties).toContain('bootVersion: 3.2.3');
+  });
 
   it('updates springCloudCommonsVersion', () => {
     expect(result.updated).toMatch(/^springCloudCommonsVersion=4\.1\.1$/m);
@@ -174,6 +179,10 @@ describe('updateGradlePropertiesContent', () => {
     expect(result.updated).toMatch(/^springCloudBusVersion=4\.1\.1$/m);
   });
 
+  it('updates verifierVersion', () => {
+    expect(result.updated).toMatch(/^verifierVersion=4\.1\.1$/m);
+  });
+
   it('leaves non-Version keys unchanged', () => {
     expect(result.updated).toMatch(/^someOtherProperty=foobar$/m);
     expect(result.updated).toMatch(/^releaseFlag=true$/m);
@@ -446,6 +455,22 @@ releaser.fixed-versions[spring-cloud-config]=4.1.1
   it('returns an empty map when no fixed-versions entries are present', () => {
     expect(parseReleaserConfig('# no versions here\n')).toEqual({});
   });
+
+  it('adds substitution entries from the versions map', () => {
+    const content = `
+releaser.fixed-versions[spring-cloud-contract]=4.1.0
+releaser.fixed-versions[spring-boot]=3.2.3
+`;
+    const versions = parseReleaserConfig(content, { verifier: 'spring-cloud-contract' });
+    expect(versions['verifier']).toBe('4.1.0');
+    expect(versions['spring-cloud-contract']).toBe('4.1.0');
+  });
+
+  it('silently ignores substitutions whose value is not in the versions map', () => {
+    const content = `releaser.fixed-versions[spring-boot]=3.2.3\n`;
+    const versions = parseReleaserConfig(content, { verifier: 'spring-cloud-contract' });
+    expect(versions['verifier']).toBeUndefined();
+  });
 });
 
 // ── detectProjectName ─────────────────────────────────────────────────────────
@@ -456,6 +481,19 @@ describe('detectProjectName', () => {
     expect(name).toBe('spring-cloud-config');
   });
 
+  it('strips -parent suffix from the artifactId', () => {
+    const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'detect-project-test-'));
+    try {
+      fs.writeFileSync(
+        path.join(tmpDir, 'pom.xml'),
+        '<project><artifactId>spring-cloud-task-parent</artifactId></project>'
+      );
+      expect(detectProjectName(tmpDir)).toBe('spring-cloud-task');
+    } finally {
+      fs.rmSync(tmpDir, { recursive: true, force: true });
+    }
+  });
+
   it('throws when no pom.xml is present in the directory', () => {
     expect(() => detectProjectName(fixturePath('gradle-project'))).toThrow(
       'No root pom.xml found'

.github/actions/update-project-versions/action.yml

@@ -44,6 +44,15 @@ inputs:
     description: 'Root directory of the project to update. Defaults to the current working directory.'
     required: false
     default: '.'
+  project-version-substitutions:
+    description: >
+      A JSON object that maps project names in pom.xml, gradle.properties, or build.gradle to versions when the action uses release-train-version
+      to derive the versions map and project version.  In some projects there may be properties for versions that don't conform to normal
+      naming conventions.  For example, in spring-cloud-contract uses verifierVersion in gradle.properties files.  This should map
+      to the version of spring-cloud-contract from the properties file for the release-train-version.  To accomplish this, you
+      can pass a JSON object {"verifier":"spring-cloud-contract"}.  This will map the verifierVersion property in gradle.properties to
+      the version of spring-cloud-contract in the properties file.
+    required: false
 
 runs:
   using: node20

.github/actions/update-project-versions/dist/index.js

@@ -28247,12 +28247,23 @@ async function run() {
     let versions;
     let projectVersion;
 
+    const substitutionsInput = core.getInput('project-version-substitutions');
+    let substitutions = {};
+    if (substitutionsInput) {
+      try {
+        substitutions = JSON.parse(substitutionsInput);
+      } catch {
+        core.setFailed('Invalid JSON supplied for the project-version-substitutions input');
+        return;
+      }
+    }
+
     if (releaseTrainVersion) {
       // ── Fetch versions from the jenkins-releaser-config properties file ──────
       const url = getReleaserConfigUrl(commercial, releaseTrainVersion);
       core.info(`Fetching releaser config from ${url}`);
       const content = await fetchReleaserConfig(url, token);
-      versions = parseReleaserConfig(content);
+      versions = parseReleaserConfig(content, substitutions);
 
       // Auto-detect the project name from the root pom.xml <artifactId>
       const projectName = detectProjectName(directory);
@@ -28337,6 +28348,8 @@ async function run() {
         const { changed } = updateBuildGradleVersion(file, projectVersion);
         if (changed) {
           core.info(`Updated ${path.relative(directory, file)}: version`);
+        } else {
+          core.info(`No changes to ${path.relative(directory, file)}: version`);
         }
       }
     }
@@ -28410,7 +28423,7 @@ async function fetchReleaserConfig(url, token) {
  * @param {string} content - raw text of the properties file
  * @returns {Record<string, string>} e.g. { "spring-boot": "3.2.3", ... }
  */
-function parseReleaserConfig(content) {
+function parseReleaserConfig(content, substitutions = {}) {
   const versions = {};
   for (const line of content.split('\n')) {
     const match = line.match(/^releaser\.fixed-versions\[([^\]]+)\]=(.+)$/);
@@ -28420,6 +28433,11 @@ function parseReleaserConfig(content) {
       versions[projectName] = version;
     }
   }
+  for (const [key, value] of Object.entries(substitutions)) {
+    if (versions[value] !== undefined) {
+      versions[key] = versions[value];
+    }
+  }
   return versions;
 }
 
@@ -28450,7 +28468,7 @@ function detectProjectName(directory) {
       'Could not auto-detect project name: no <artifactId> found in root pom.xml'
     );
   }
-  return String(artifactId);
+  return artifactIdToProjectName(String(artifactId));
 }
 
 // ── pom.xml ────────────────────────────────────────────────────────────────

.github/actions/update-project-versions/src/index.js

@@ -22,12 +22,23 @@ async function run() {
     let versions;
     let projectVersion;
 
+    const substitutionsInput = core.getInput('project-version-substitutions');
+    let substitutions = {};
+    if (substitutionsInput) {
+      try {
+        substitutions = JSON.parse(substitutionsInput);
+      } catch {
+        core.setFailed('Invalid JSON supplied for the project-version-substitutions input');
+        return;
+      }
+    }
+
     if (releaseTrainVersion) {
       // ── Fetch versions from the jenkins-releaser-config properties file ──────
       const url = getReleaserConfigUrl(commercial, releaseTrainVersion);
       core.info(`Fetching releaser config from ${url}`);
       const content = await fetchReleaserConfig(url, token);
-      versions = parseReleaserConfig(content);
+      versions = parseReleaserConfig(content, substitutions);
 
       // Auto-detect the project name from the root pom.xml <artifactId>
       const projectName = detectProjectName(directory);
@@ -112,6 +123,8 @@ async function run() {
         const { changed } = updateBuildGradleVersion(file, projectVersion);
         if (changed) {
           core.info(`Updated ${path.relative(directory, file)}: version`);
+        } else {
+          core.info(`No changes to ${path.relative(directory, file)}: version`);
         }
       }
     }
@@ -185,7 +198,7 @@ async function fetchReleaserConfig(url, token) {
  * @param {string} content - raw text of the properties file
  * @returns {Record<string, string>} e.g. { "spring-boot": "3.2.3", ... }
  */
-function parseReleaserConfig(content) {
+function parseReleaserConfig(content, substitutions = {}) {
   const versions = {};
   for (const line of content.split('\n')) {
     const match = line.match(/^releaser\.fixed-versions\[([^\]]+)\]=(.+)$/);
@@ -195,6 +208,11 @@ function parseReleaserConfig(content) {
       versions[projectName] = version;
     }
   }
+  for (const [key, value] of Object.entries(substitutions)) {
+    if (versions[value] !== undefined) {
+      versions[key] = versions[value];
+    }
+  }
   return versions;
 }
 
@@ -225,7 +243,7 @@ function detectProjectName(directory) {
       'Could not auto-detect project name: no <artifactId> found in root pom.xml'
     );
   }
-  return String(artifactId);
+  return artifactIdToProjectName(String(artifactId));
 }
 
 // ── pom.xml ────────────────────────────────────────────────────────────────