chore: align env var names and clean up script a bit

Author: pichlermarc

.github/workflows/create-or-update-release-pr.yml

@@ -53,5 +53,5 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ steps.otelbot-token.outputs.token }}
           RELEASE_SCOPE: ${{ github.event.inputs.release_scope }}
-          RELEASE_BUMP: ${{ github.event.inputs.release_type }}
+          RELEASE_TYPE: ${{ github.event.inputs.release_type }}
           RELEASE_PR_REMOTE: origin

package.json

@@ -33,7 +33,7 @@
     "prepare_release:experimental": "npm run _check:no_changes && npm run _backup:package-json && npm run _workspace:remove_api && npm run _workspace:remove_semconv && npm run _workspace:remove_stable && npm run _workspace:bump_version && npm run _restore:package-json && npm run _changelog:prepare_experimental",
     "prepare_release:sdk": "npm run _check:no_changes && npm run _backup:package-json && npm run _workspace:remove_api && npm run _workspace:remove_semconv && npm run _workspace:bump_version && npm run _restore:package-json && npm run _changelog:prepare_experimental && npm run _changelog:prepare_stable",
     "prepare_release:semconv": "npm run _check:no_changes && npm run _backup:package-json && npm run _workspace:remove_everything_except_semconv && npm run _workspace:bump_version && npm run _restore:package-json && npm run _changelog:prepare_semconv",
-    "prepare_release:all": "npm run _check:no_changes && npm run _backup:package-json && npm run _workspace:remove_api && npm run _workspace:remove_semconv && npm run _workspace:bump_version && cd api/ && npm version $RELEASE_BUMP && cd .. && nx run-many -t align-api-deps && npm run _restore:package-json && npm run _changelog:prepare_all",
+    "prepare_release:all": "npm run _check:no_changes && npm run _backup:package-json && npm run _workspace:remove_api && npm run _workspace:remove_semconv && npm run _workspace:bump_version && cd api/ && npm version $RELEASE_TYPE && cd .. && nx run-many -t align-api-deps && npm run _restore:package-json && npm run _changelog:prepare_all",
     "comment_internal": "echo scripts below this line are for internal use",
     "_check:no_changes": "if [ ! -z \"$(git status -uall --porcelain)\" ]; then echo Please ensure all changes are committed; exit 1; fi",
     "_backup:package-json": "cp package.json package.json.backup",
@@ -59,9 +59,9 @@
     "_github:update_release_pr_body:experimental": "node scripts/extract-latest-release-notes.js experimental/CHANGELOG.md && npm run _github:update_release_pr_body_from_file",
     "_github:update_release_pr_body:semconv": "node scripts/extract-latest-release-notes.js semantic-conventions/CHANGELOG.md && npm run _github:update_release_pr_body_from_file",
     "_verify_release_kind": "echo $RELEASE_SCOPE | grep -oE '^(all|sdk|experimental|semconv)$'",
-    "_verify_release_bump": "echo $RELEASE_BUMP | grep -oE '^(minor|patch)$'",
+    "_verify_release_type": "echo $RELEASE_TYPE | grep -oE '^(minor|patch)$'",
     "_verify_release_remote": "git remote get-url $RELEASE_PR_REMOTE",
-    "_github:update_release_branch": "npm run _verify_release_kind && npm run _verify_release_bump && npm run _verify_release_remote && (git checkout main && git pull $RELEASE_PR_REMOTE main && git branch -D otelbot/prepare-next-version; git checkout -b otelbot/prepare-next-version && npm run prepare_release:$RELEASE_SCOPE && git commit -am \"chore: prepare release\" && git push --set-upstream $RELEASE_PR_REMOTE --force otelbot/prepare-next-version)",
+    "_github:update_release_branch": "npm run _verify_release_kind && npm run _verify_release_type && npm run _verify_release_remote && (git checkout main && git pull $RELEASE_PR_REMOTE main && git branch -D otelbot/prepare-next-version; git checkout -b otelbot/prepare-next-version && npm run prepare_release:$RELEASE_SCOPE && git commit -am \"chore: prepare release\" && git push --set-upstream $RELEASE_PR_REMOTE --force otelbot/prepare-next-version)",
     "github:create_or_update_release_pr": "npm run _github:update_release_branch && (gh pr create --repo open-telemetry/opentelemetry-js --title 'chore: prepare next release' --body ''; npm run _github:update_release_pr_body:$RELEASE_SCOPE)"
   },
   "repository": "open-telemetry/opentelemetry-js",

scripts/bump-versions.mjs

@@ -1,11 +1,24 @@
+/**
+ * This bumps all package versions based on the environment variable RELEASE_TYPE (allowed values 'minor' and 'patch'),
+ * then aligns all packages in the workspace to depend on that version IFF the dependency version is pinned. Packages
+ * like `@opentelemetry/semantic-conventions` which are unpinned on purpose will not be bumped.
+ *
+ * All packages versions are bumped in unison to satisfy this specification requirement:
+ * https://github.com/open-telemetry/opentelemetry-specification/blob/v1.49.0/specification/versioning-and-stability.md?plain=1#L353-L355
+ *
+ * Usage (from package directory):
+ * - RELEASE_TYPE=minor node <repo-root>/scripts/bump-versions.js # bumps minor version in all packages
+ * - RELEASE_TYPE=patch node <repo-root>/scripts/bump-versions.js # bumps patch version in all packages
+ */
+
 import * as fs from 'fs';
 import * as path from 'path';
 import * as glob from 'glob';
 
-const RELEASE_BUMP = process.env.RELEASE_BUMP;
+const RELEASE_TYPE = process.env.RELEASE_TYPE;
 
-if (!['minor', 'patch'].includes(RELEASE_BUMP)) {
-  console.error('RELEASE_BUMP must be either "minor" or "patch"');
+if (!['minor', 'patch'].includes(RELEASE_TYPE)) {
+  console.error('RELEASE_TYPE must be either "minor" or "patch"');
   process.exit(1);
 }
 
@@ -58,11 +71,11 @@ packagePaths.forEach(pkgPath => {
   const pkgJson = JSON.parse(fs.readFileSync(pkgJsonPath, 'utf-8'));
 
   const oldVersion = pkgJson.version;
-  const newVersion = bumpVersion(oldVersion, RELEASE_BUMP);
+  const newVersion = bumpVersion(oldVersion, RELEASE_TYPE);
   pkgJson.version = newVersion;
   updatedVersions[pkgJson.name] = newVersion;
 
-  fs.writeFileSync(pkgJsonPath, JSON.stringify(pkgJson, null, 2));
+  fs.writeFileSync(pkgJsonPath, JSON.stringify(pkgJson, null, 2) + '\n');
   console.info(`Bumped ${pkgJson.name} from ${oldVersion} to ${newVersion}`);
 });
 
@@ -73,6 +86,6 @@ packagePaths.forEach(pkgPath => {
 
   updatePinnedDependencies(pkgJson, updatedVersions);
 
-  fs.writeFileSync(pkgJsonPath, JSON.stringify(pkgJson, null, 2));
+  fs.writeFileSync(pkgJsonPath, JSON.stringify(pkgJson, null, 2) + '\n');
   console.info(`Updated dependencies for ${pkgJson.name}`);
 });