Write version and date to changelog when packaging (#1639)

* Write version and date to changelog when packaging

The version in "package.json" will be baseline, each type of extension
packaging can control the version string for that version of the log

* Fix formatting issues

Author: award999

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Changelog
 
-## 2.6.0 - TBD
+## {{releaseVersion}} - {{releaseDate}}
 
 ### Added
 

package-lock.json

@@ -1682,7 +1682,7 @@
     "unit-test": "npm test -- --label unitTests",
     "coverage": "npm test -- --coverage",
     "compile-tests": "del-cli ./assets/test/**/.build && npm run compile",
-    "package": "vsce package",
+    "package": "tsx ./scripts/package.ts",
     "dev-package": "tsx ./scripts/dev_package.ts",
     "preview-package": "tsx ./scripts/preview_package.ts",
     "tag": "./scripts/tag_release.sh $npm_package_version",
@@ -1727,6 +1727,7 @@
     "node-pty": "^1.0.0",
     "octokit": "^3.2.2",
     "prettier": "^3.6.0",
+    "replace-in-file": "^8.3.0",
     "semver": "^7.7.2",
     "simple-git": "^3.28.0",
     "sinon": "^21.0.0",

package.json

@@ -13,7 +13,13 @@
 //===----------------------------------------------------------------------===//
 /* eslint-disable no-console */
 
-import { exec, getExtensionVersion, getRootDirectory, main } from "./lib/utilities";
+import {
+    exec,
+    getExtensionVersion,
+    getRootDirectory,
+    main,
+    updateChangelog,
+} from "./lib/utilities";
 
 // eslint-disable-next-line @typescript-eslint/no-floating-promises
 main(async () => {
@@ -22,6 +28,8 @@ main(async () => {
     // Increment the patch version from the package.json
     const patch = version.patch + 1;
     const devVersion = `${version.major}.${version.minor}.${patch}-dev`;
+    // Update version in CHANGELOG
+    await updateChangelog(devVersion);
     // Use VSCE to package the extension
     await exec("npx", ["vsce", "package", "--no-update-package-json", devVersion], {
         cwd: rootDirectory,

scripts/dev_package.ts

@@ -18,6 +18,7 @@ import { mkdtemp, readFile, rm } from "fs/promises";
 import * as path from "path";
 import * as os from "os";
 import * as semver from "semver";
+import { replaceInFile } from "replace-in-file";
 
 /**
  * Executes the provided main function for the script while logging any errors.
@@ -42,13 +43,25 @@ export function getRootDirectory(): string {
     return path.join(__dirname, "..", "..");
 }
 
+/**
+ * Returns the path to the extension manifest.
+ */
+export function getManifest(): string {
+    return path.join(getRootDirectory(), "package.json");
+}
+
+/**
+ * Returns the path to the extension changelog.
+ */
+export function getChangelog(): string {
+    return path.join(getRootDirectory(), "CHANGELOG.md");
+}
+
 /**
  * Retrieves the version number from the package.json.
  */
 export async function getExtensionVersion(): Promise<semver.SemVer> {
-    const packageJSON = JSON.parse(
-        await readFile(path.join(getRootDirectory(), "package.json"), "utf-8")
-    );
+    const packageJSON = JSON.parse(await readFile(getManifest(), "utf-8"));
     if (typeof packageJSON.version !== "string") {
         throw new Error("Version number in package.json is not a string");
     }
@@ -112,3 +125,20 @@ export async function withTemporaryDirectory<T>(
         });
     }
 }
+
+export async function updateChangelog(version: string): Promise<void> {
+    await replaceInFile({
+        files: getChangelog(),
+        from: /{{releaseVersion}}/g,
+        to: version,
+    });
+    const date = new Date();
+    const year = date.getUTCFullYear().toString().padStart(4, "0");
+    const month = (date.getUTCMonth() + 1).toString().padStart(2, "0");
+    const day = date.getUTCDate().toString().padStart(2, "0");
+    await replaceInFile({
+        files: getChangelog(),
+        from: /{{releaseDate}}/g,
+        to: `${year}-${month}-${day}`,
+    });
+}

scripts/lib/utilities.ts

@@ -0,0 +1,35 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the VS Code Swift open source project
+//
+// Copyright (c) 2025 the VS Code Swift project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of VS Code Swift project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+/* eslint-disable no-console */
+
+import {
+    exec,
+    getExtensionVersion,
+    getRootDirectory,
+    main,
+    updateChangelog,
+} from "./lib/utilities";
+
+// eslint-disable-next-line @typescript-eslint/no-floating-promises
+main(async () => {
+    const rootDirectory = getRootDirectory();
+    const version = await getExtensionVersion();
+    const versionString = `${version.major}.${version.minor}.${version.patch}`;
+    // Update version in CHANGELOG
+    await updateChangelog(versionString);
+    // Use VSCE to package the extension
+    await exec("npx", ["vsce", "package"], {
+        cwd: rootDirectory,
+    });
+});

scripts/package.ts

@@ -12,8 +12,13 @@
 //
 //===----------------------------------------------------------------------===//
 /* eslint-disable no-console */
-
-import { exec, getExtensionVersion, getRootDirectory, main } from "./lib/utilities";
+import {
+    exec,
+    getExtensionVersion,
+    getRootDirectory,
+    main,
+    updateChangelog,
+} from "./lib/utilities";
 
 /**
  * Formats the given date as a string in the form "YYYYMMdd".
@@ -43,6 +48,8 @@ main(async () => {
                 " The version in the package.json has probably been incorrectly set to an odd minor version."
         );
     }
+    // Update version in CHANGELOG
+    await updateChangelog(previewVersion);
     // Use VSCE to package the extension
     await exec(
         "npx",