Update gradle properties versions

Author: ryanjbaxter

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

@@ -14,6 +14,7 @@ const {
   hasVersionCheckOff,
   updateGradlePropertiesContent,
   updateBuildGradleContent,
+  projectForArtifact,
   camelToKebab,
   artifactIdToProjectName,
   isChildOfRoot,
@@ -232,6 +233,45 @@ describe('updateGradlePropertiesContent', () => {
   });
 });
 
+// ── projectForArtifact ────────────────────────────────────────────────────────
+
+describe('projectForArtifact', () => {
+  const versions = {
+    'spring-boot': '4.2.0-M2',
+    'spring-cloud-function': '5.1.0-M1',
+    'spring-cloud-config': '5.1.0-M1',
+  };
+
+  it('resolves an exact project name', () => {
+    expect(projectForArtifact('spring-cloud-function', versions)).toBe('spring-cloud-function');
+  });
+
+  // Spring Cloud publishes a project's modules at the project's own version.
+  it('resolves a module to the project that releases it', () => {
+    expect(projectForArtifact('spring-cloud-function-adapter-azure', versions))
+      .toBe('spring-cloud-function');
+    expect(projectForArtifact('spring-cloud-config-server', versions))
+      .toBe('spring-cloud-config');
+    expect(projectForArtifact('spring-boot-starter-web', versions)).toBe('spring-boot');
+  });
+
+  // The boundary is what stops spring-cloud-configuration resolving to spring-cloud-config.
+  it('only matches on a dash boundary', () => {
+    expect(projectForArtifact('spring-cloud-configuration', versions)).toBeNull();
+  });
+
+  it('prefers the longest match', () => {
+    const nested = { 'spring-cloud': 'a', 'spring-cloud-function': 'b' };
+    expect(projectForArtifact('spring-cloud-function-adapter-azure', nested))
+      .toBe('spring-cloud-function');
+  });
+
+  it('returns null for an artifact no project releases', () => {
+    expect(projectForArtifact('some-other-lib', versions)).toBeNull();
+    expect(projectForArtifact('spring-cloud-starter-function-web', versions)).toBeNull();
+  });
+});
+
 // ── updateBuildGradleContent ──────────────────────────────────────────────────
 
 describe('updateBuildGradleContent', () => {
@@ -254,6 +294,107 @@ describe('updateBuildGradleContent', () => {
     expect(updated).toContain(`description = 'My project'`);
   });
 
+  // spring-cloud-function's Gradle samples declare these in an ext block rather than in
+  // gradle.properties, so a release used to leave them at whatever they had been pinned at
+  // - Boot 2.1.0.BUILD-SNAPSHOT in a train releasing against Boot 4.
+  describe('version properties in an ext block', () => {
+    const versions = {
+      'spring-boot': '4.2.0-M2',
+      'spring-cloud-function': '5.1.0-M1',
+    };
+
+    it('updates a property inside buildscript { ext { } }', () => {
+      const content = [
+        'buildscript {',
+        '\text {',
+        "\t\tspringBootVersion = '2.1.0.BUILD-SNAPSHOT'",
+        '\t}',
+        '}',
+      ].join('\n');
+      const { updated, updatedProperties } =
+        updateBuildGradleContent(content, '5.1.0-M1', versions);
+      expect(updated).toContain("springBootVersion = '4.2.0-M2'");
+      expect(updatedProperties).toEqual(['springBootVersion: 4.2.0-M2']);
+    });
+
+    it('updates a double-quoted property and preserves the quote style', () => {
+      const content = 'ext {\n\tspringCloudFunctionVersion = "2.0.0.BUILD-SNAPSHOT"\n}';
+      const { updated } = updateBuildGradleContent(content, '5.1.0-M1', versions);
+      expect(updated).toContain('springCloudFunctionVersion = "5.1.0-M1"');
+    });
+
+    it('preserves indentation', () => {
+      const content = "    springBootVersion = '2.1.0.BUILD-SNAPSHOT'";
+      const { updated } = updateBuildGradleContent(content, '5.1.0-M1', versions);
+      expect(updated).toBe("    springBootVersion = '4.2.0-M2'");
+    });
+
+    it('leaves a property that resolves to no project alone', () => {
+      const content = "ext {\n\tjavaVersion = '11'\n}";
+      const { updated, updatedProperties } =
+        updateBuildGradleContent(content, '5.1.0-M1', versions);
+      expect(updated).toBe(content);
+      expect(updatedProperties).toEqual([]);
+    });
+
+    it('leaves an unquoted value alone', () => {
+      const content = 'languageVersion = JavaLanguageVersion.of(17)';
+      expect(updateBuildGradleContent(content, '5.1.0-M1', versions).updated).toBe(content);
+    });
+
+    it('does not treat the project version line as a property', () => {
+      const content = "version = '5.0.0'\n";
+      const { updated, updatedProperties } =
+        updateBuildGradleContent(content, '5.1.0-M1', versions);
+      expect(updated).toBe("version = '5.1.0-M1'\n");
+      expect(updatedProperties).toEqual([]);
+    });
+
+    it('updates the project version and its properties together', () => {
+      const content = [
+        "version = '5.1.0-INTERNAL-SNAPSHOT'",
+        'ext {',
+        "\tspringCloudFunctionVersion = '2.0.0.BUILD-SNAPSHOT'",
+        '}',
+      ].join('\n');
+      const { updated } = updateBuildGradleContent(content, '5.1.0-M1', versions);
+      expect(updated).toContain("version = '5.1.0-M1'");
+      expect(updated).toContain("springCloudFunctionVersion = '5.1.0-M1'");
+    });
+
+    it('rewrites an inline dependency coordinate for a released artifact', () => {
+      const content =
+        'implementation "org.springframework.cloud:spring-cloud-function-adapter-azure:4.1.0-SNAPSHOT"';
+      const { updated, updatedProperties } =
+        updateBuildGradleContent(content, '5.1.0-M1', versions);
+      expect(updated).toContain(
+        '"org.springframework.cloud:spring-cloud-function-adapter-azure:5.1.0-M1"');
+      expect(updatedProperties).toEqual(['spring-cloud-function-adapter-azure: 5.1.0-M1']);
+    });
+
+    // Replacing the reference with a literal would break the indirection the build uses.
+    it('leaves an interpolated coordinate version alone', () => {
+      const content =
+        'mavenBom "org.springframework.cloud:spring-cloud-function-dependencies:${springCloudFunctionVersion}"';
+      expect(updateBuildGradleContent(content, '5.1.0-M1', versions).updated).toBe(content);
+    });
+
+    it('leaves a non-Spring group alone even when the artifact name matches', () => {
+      const content = "implementation 'com.example:spring-cloud-function-fork:1.0.0-SNAPSHOT'";
+      expect(updateBuildGradleContent(content, '5.1.0-M1', versions).updated).toBe(content);
+    });
+
+    it('leaves a coordinate with no version alone', () => {
+      const content = "implementation 'org.springframework.cloud:spring-cloud-function-context'";
+      expect(updateBuildGradleContent(content, '5.1.0-M1', versions).updated).toBe(content);
+    });
+
+    it('is a no-op when no versions map is supplied', () => {
+      const content = "ext {\n\tspringBootVersion = '2.1.0.BUILD-SNAPSHOT'\n}";
+      expect(updateBuildGradleContent(content, '5.1.0-M1').updated).toBe(content);
+    });
+  });
+
   it('returns unchanged content when no version declaration is present', () => {
     const content = `group = 'org.example'\n`;
     expect(updateBuildGradleContent(content, '3.1.1').updated).toBe(content);

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

@@ -28374,20 +28374,25 @@ async function run() {
     }
 
     // ── build.gradle / build.gradle.kts ────────────────────────────────────
-    // Only the project version declaration is updated (version = '...' / version = "...").
-    // Dependency versions are managed exclusively via gradle.properties in Spring Cloud.
+    // The project version declaration, plus any `{prefix}Version` properties declared in an
+    // ext block rather than in gradle.properties.
     const buildGradleFiles = [
       ...findFiles(directory, 'build.gradle'),
       ...findFiles(directory, 'build.gradle.kts'),
     ];
     if (buildGradleFiles.length > 0) {
       core.info(`Found ${buildGradleFiles.length} build.gradle file(s)`);
       for (const file of buildGradleFiles) {
-        const { changed } = updateBuildGradleVersion(file, projectVersion);
+        const { changed, updatedProperties } = updateBuildGradleVersion(
+          file,
+          projectVersion,
+          versions
+        );
         if (changed) {
-          core.info(`Updated ${path.relative(directory, file)}: version`);
+          core.info(`Updated ${path.relative(directory, file)}: ` +
+            ['version', ...updatedProperties].join(', '));
         } else {
-          core.info(`No changes to ${path.relative(directory, file)}: version`);
+          core.info(`No changes to ${path.relative(directory, file)}`);
         }
       }
     }
@@ -28774,27 +28779,29 @@ function updateGradlePropertiesContent(content, projectVersion, versions) {
 // ── build.gradle / build.gradle.kts ───────────────────────────────────────
 
 /**
- * Updates the project version declaration in a build.gradle or build.gradle.kts file.
- * Handles both single-quoted and double-quoted versions:
+ * Updates the project version declaration and any version properties in a build.gradle
+ * or build.gradle.kts file. Handles both single-quoted and double-quoted versions:
  *   version = '4.1.0'
- *   version = "4.1.0"
- *
- * Only the project-level version line is updated; dependency version properties
- * are managed via gradle.properties in Spring Cloud projects.
+ *   springCloudFunctionVersion = "4.1.0"
  *
  * Exported for unit testing.
  *
  * @param {string} filePath
  * @param {string} projectVersion
+ * @param {Record<string, string>} versions
  */
-function updateBuildGradleVersion(filePath, projectVersion) {
+function updateBuildGradleVersion(filePath, projectVersion, versions) {
   const content = fs.readFileSync(filePath, 'utf-8');
-  const { updated } = updateBuildGradleContent(content, projectVersion);
+  const { updated, updatedProperties } = updateBuildGradleContent(
+    content,
+    projectVersion,
+    versions
+  );
   const changed = updated !== content;
   if (changed) {
     fs.writeFileSync(filePath, updated, 'utf-8');
   }
-  return { changed };
+  return { changed, updatedProperties };
 }
 
 /**
@@ -28803,14 +28810,64 @@ function updateBuildGradleVersion(filePath, projectVersion) {
  *
  * Exported for unit testing.
  */
-function updateBuildGradleContent(content, projectVersion) {
+function updateBuildGradleContent(content, projectVersion, versions = {}) {
   // Match: version = '...' or version = "..." at the start of a line (with optional spaces)
-  const updated = content.replace(
+  const withProjectVersion = content.replace(
     /^(version\s*=\s*)(['"])([^'"]+)(['"])/m,
     (_, prefix, openQuote, _oldVersion, closeQuote) =>
       `${prefix}${openQuote}${projectVersion}${closeQuote}`
   );
-  return { updated };
+
+  // `{prefix}Version` assignments, resolved exactly as they are in gradle.properties:
+  // camelCase prefix -> kebab-case project name -> the train's version for it. These live
+  // in an `ext { }` or `buildscript { ext { } }` block rather than at the start of a line,
+  // so leading whitespace is part of the match and is preserved.
+  //
+  // Spring Cloud projects mostly declare these in gradle.properties, which is why this
+  // file only ever rewrote the project version. spring-cloud-function's Gradle samples
+  // declare them here instead, so a release left them at whatever they had been pinned at.
+  //
+  // A key that resolves to no project is left alone, which is what keeps `javaVersion` and
+  // similar build settings out of it.
+  const updatedProperties = [];
+  const updated = withProjectVersion.split('\n').map((line) => {
+    const match = line.match(
+      /^(\s*)([a-zA-Z][a-zA-Z0-9]*Version)(\s*=\s*)(['"])([^'"]+)(['"])(.*)$/
+    );
+    if (!match) return line;
+
+    const [, indent, key, separator, openQuote, currentValue, closeQuote, trailing] = match;
+    const projectName = camelToKebab(key.slice(0, -'Version'.length));
+    const targetVersion = versions[projectName];
+    if (!targetVersion || currentValue === targetVersion) return line;
+
+    updatedProperties.push(`${key}: ${targetVersion}`);
+    return `${indent}${key}${separator}${openQuote}${targetVersion}${closeQuote}${trailing}`;
+  }).join('\n');
+
+  // Inline dependency coordinates - "group:artifact:version" - for artifacts this train
+  // releases. Most Spring Cloud builds express these through a property or let the BOM
+  // manage them, which is why this file never needed it; spring-cloud-function's Azure
+  // sample pins one directly.
+  //
+  // Only org.springframework.* groups, so a third-party artifact that happens to share a
+  // prefix is never touched, and never when the version is an interpolation - rewriting
+  // "...:${springCloudFunctionVersion}" would replace the reference with a literal and
+  // break the very indirection the build is using.
+  const COORDINATE = /(['"])(org\.springframework\.[a-z0-9.]+):([A-Za-z0-9_.-]+):([^'"]+)\1/g;
+  const withCoordinates = updated.replace(
+    COORDINATE,
+    (whole, quote, groupId, artifactId, version) => {
+      if (version.includes('$')) return whole;
+      const projectName = projectForArtifact(artifactId, versions);
+      const targetVersion = projectName && versions[projectName];
+      if (!targetVersion || version === targetVersion) return whole;
+      updatedProperties.push(`${artifactId}: ${targetVersion}`);
+      return `${quote}${groupId}:${artifactId}:${targetVersion}${quote}`;
+    }
+  );
+
+  return { updated: withCoordinates, updatedProperties };
 }
 
 // ── Utilities ──────────────────────────────────────────────────────────────
@@ -28861,6 +28918,31 @@ function artifactIdToProjectName(artifactId) {
     .replace(/-parent$/, '');
 }
 
+/**
+ * Resolves a Maven artifactId to the project in `versions` that releases it: an exact
+ * match, or the longest project name the artifactId extends on a `-` boundary.
+ *
+ * Spring Cloud publishes a project's modules at the project's own version, so
+ * spring-cloud-function-adapter-azure ships with spring-cloud-function and
+ * spring-cloud-config-server with spring-cloud-config. The boundary matters:
+ * spring-cloud-configuration would not resolve to spring-cloud-config.
+ *
+ * Longest wins so a project whose name extends another still resolves to itself.
+ * Returns null when nothing matches, which leaves the coordinate alone.
+ *
+ * Exported for unit testing.
+ */
+function projectForArtifact(artifactId, versions) {
+  if (Object.prototype.hasOwnProperty.call(versions, artifactId)) return artifactId;
+  let best = null;
+  for (const name of Object.keys(versions)) {
+    if (artifactId.startsWith(`${name}-`) && (best === null || name.length > best.length)) {
+      best = name;
+    }
+  }
+  return best;
+}
+
 /**
  * Returns true when a child pom's parent is part of this project
  * (i.e. not an external parent like spring-boot-starter-parent or
@@ -28932,6 +29014,7 @@ module.exports = {
   findFiles,
   camelToKebab,
   artifactIdToProjectName,
+  projectForArtifact,
   isChildOfRoot,
 };