chore(ci): manage utils package version to bump versions correctly (#346)

* chore(ci): manage utils package version to bump versions correctly

* chore: add utils version if not exist

* chore: add comment

Author: eunjae-lee

openapitools.json

@@ -22,7 +22,8 @@
           "apiName": "search",
           "capitalizedApiName": "Search",
           "packageVersion": "0.0.5",
-          "packageName": "@experimental-api-clients-automation/client-search"
+          "packageName": "@experimental-api-clients-automation/client-search",
+          "utilsPackageVersion": "0.0.5"
         }
       },
       "javascript-recommend": {
@@ -44,7 +45,8 @@
           "apiName": "recommend",
           "capitalizedApiName": "Recommend",
           "packageVersion": "0.0.5",
-          "packageName": "@experimental-api-clients-automation/recommend"
+          "packageName": "@experimental-api-clients-automation/recommend",
+          "utilsPackageVersion": "0.0.5"
         }
       },
       "javascript-personalization": {
@@ -69,7 +71,8 @@
           "hasRegionalHost": true,
           "isEuHost": true,
           "host": "personalization",
-          "topLevelDomain": "com"
+          "topLevelDomain": "com",
+          "utilsPackageVersion": "0.0.5"
         }
       },
       "javascript-analytics": {
@@ -95,7 +98,8 @@
           "hasRegionalHost": true,
           "isDeHost": true,
           "host": "analytics",
-          "topLevelDomain": "com"
+          "topLevelDomain": "com",
+          "utilsPackageVersion": "0.0.5"
         }
       },
       "javascript-insights": {
@@ -121,7 +125,8 @@
           "hasRegionalHost": true,
           "isDeHost": true,
           "host": "insights",
-          "topLevelDomain": "io"
+          "topLevelDomain": "io",
+          "utilsPackageVersion": "0.0.5"
         }
       },
       "javascript-abtesting": {
@@ -147,7 +152,8 @@
           "fallbackToAliasHost": true,
           "isDeHost": true,
           "host": "analytics",
-          "topLevelDomain": "com"
+          "topLevelDomain": "com",
+          "utilsPackageVersion": "0.0.5"
         }
       },
       "javascript-query-suggestions": {
@@ -172,7 +178,8 @@
           "hasRegionalHost": true,
           "isEuHost": true,
           "host": "query-suggestions",
-          "topLevelDomain": "com"
+          "topLevelDomain": "com",
+          "utilsPackageVersion": "0.0.5"
         }
       },
       "javascript-sources": {
@@ -197,7 +204,8 @@
           "hasRegionalHost": true,
           "isDeHost": true,
           "host": "data",
-          "topLevelDomain": "com"
+          "topLevelDomain": "com",
+          "utilsPackageVersion": "0.0.5"
         }
       },
       "javascript-predict": {
@@ -219,7 +227,8 @@
           "capitalizedApiName": "Predict",
           "packageVersion": "0.0.5",
           "packageName": "@experimental-api-clients-automation/client-predict",
-          "experimentalHost": "predict-api-oslcbws3zq-ew.a.run.app"
+          "experimentalHost": "predict-api-oslcbws3zq-ew.a.run.app",
+          "utilsPackageVersion": "0.0.5"
         }
       },
       "java-search": {

scripts/release/process-release.ts

@@ -28,6 +28,7 @@ import {
   configureGitHubAuthor,
   cloneRepository,
   getOctokit,
+  MAIN_PACKAGE,
 } from './common';
 import TEXT from './text';
 import type {
@@ -103,22 +104,36 @@ export function getVersionsToRelease(issueBody: string): VersionsToRelease {
 async function updateOpenApiTools(
   versionsToRelease: VersionsToRelease
 ): Promise<void> {
+  const nextUtilsPackageVersion = semver.inc(
+    openapitools['generator-cli'].generators[MAIN_PACKAGE.javascript]
+      .additionalProperties.utilsPackageVersion,
+    versionsToRelease.javascript?.releaseType
+  );
+
   Object.keys(openapitools['generator-cli'].generators).forEach((client) => {
     const lang = client.split('-')[0];
     if (versionsToRelease[lang]) {
       const additionalProperties =
         openapitools['generator-cli'].generators[client].additionalProperties;
+      const releaseType = versionsToRelease[lang].releaseType;
 
       const newVersion = semver.inc(
         additionalProperties.packageVersion,
-        versionsToRelease[lang].releaseType
+        releaseType
       );
       if (!newVersion) {
         throw new Error(
-          `Failed to bump version ${additionalProperties.packageVersion} by ${versionsToRelease[lang].releaseType}.`
+          `Failed to bump version ${additionalProperties.packageVersion} by ${releaseType}.`
         );
       }
       additionalProperties.packageVersion = newVersion;
+
+      // In case we're not releasing javascript package,
+      // we shouldn't bump the utils version.
+      // At that time `nextUtilsPackageVersion` is undefined, and the following branch is skipped.
+      if (lang === 'javascript' && nextUtilsPackageVersion) {
+        additionalProperties.utilsPackageVersion = nextUtilsPackageVersion;
+      }
     }
   });
   await fsp.writeFile(

templates/javascript/package.mustache

@@ -24,9 +24,9 @@
     "node": ">= 14.0.0"
   },
   "dependencies": {
-    "@experimental-api-clients-automation/client-common": "^0.0.5",
-    "@experimental-api-clients-automation/requester-browser-xhr": "^0.0.5",
-    "@experimental-api-clients-automation/requester-node-http": "^0.0.5"
+    "@experimental-api-clients-automation/client-common": "{{utilsPackageVersion}}",
+    "@experimental-api-clients-automation/requester-browser-xhr": "{{utilsPackageVersion}}",
+    "@experimental-api-clients-automation/requester-node-http": "{{utilsPackageVersion}}"
   },
   "devDependencies": {
     "@types/node": "16.11.26",