Update the CHANGELOG entry using npm version hook

Update the CHANGELOG entry using the "version" lifecycle hook
which will execute after the `npm version` is completed.

> If preversion, version, or postversion are in the scripts property of the package.json, they will be executed as part of running npm version.
> The exact order of execution is as follows:
> 1. Check to make sure the git working directory is clean before we get started. Your scripts may add files to the commit in future steps. This step is skipped if the --force flag is set.
> 2. Run the preversion script. These scripts have access to the old version in package.json. A typical use would be running your full test suite before deploying. Any files you want added to the commit should be explicitly added using git add.
> 3. Bump version in package.json as requested (patch, minor, major, etc).
> 4. Run the version script. These scripts have access to the new version in package.json (so they can incorporate it into file headers in generated files for example). Again, scripts should explicitly add generated files to the commit using git add.
> 5. Commit and tag.
> 6. Run the postversion script. Use it to clean up the file system or automatically push the commit and/or tag.

https://docs.npmjs.com/cli/v11/commands/npm-version#description

Uses undocumented environment variables to get both the old and new
versions:
https://github.com/npm/cli/blob/c97b39b1e3436cd20a67ab5f4012a5f395c538b9/workspaces/libnpmversion/lib/version.js#L100-L103

Author: NickColley

.github/workflows/build-release.yml

@@ -64,31 +64,17 @@ jobs:
       - name: Install dependencies
         run: npm ci
 
-      - name: Save current version
-        run: echo "PREVIOUS_PACKAGE_VERSION=$(npm run get-version --silent --workspace govuk-frontend)" >> $GITHUB_ENV
-
-      - name: Update package version
-        run: |
-          npm version --no-git-tag-version --workspace govuk-frontend "$RELEASE_TYPE" --preid "$PREID"
-
-          # Save the new version number for access in future steps
-          echo "PACKAGE_VERSION=$(npm run get-version --silent --workspace govuk-frontend)" >> $GITHUB_ENV
-
-      - name: Update CHANGELOG
-        uses: actions/github-script@v9.0.0
-        with:
-          script: |
-            const { updateChangelog } = await import('${{ github.workspace }}/shared/github-scripts/changelog-release-helper.mjs')
-
-            updateChangelog(process.env.PACKAGE_VERSION, process.env.PREVIOUS_PACKAGE_VERSION)
+      - name: Update package version and update the CHANGELOG
+        run: npm version --no-git-tag-version --workspace govuk-frontend "$RELEASE_TYPE" --preid "$PREID"
 
       - name: Generate release notes
         uses: actions/github-script@v9.0.0
         with:
           script: |
             const { generateReleaseNotes } = await import('${{ github.workspace }}/shared/github-scripts/changelog-release-helper.mjs')
 
-            generateReleaseNotes(process.env.PACKAGE_VERSION, { actor: '${{ github.actor }}', runId: '${{ github.run_id }}' })
+            PACKAGE_VERSION=$(npm run get-version --silent --workspace govuk-frontend)
+            generateReleaseNotes(PACKAGE_VERSION, { actor: '${{ github.actor }}', runId: '${{ github.run_id }}' })
 
       - name: Build release
         run: npm run build:release

bin/update-changelog.mjs

@@ -0,0 +1,14 @@
+import { updateChangelog } from '../shared/github-scripts/changelog-release-helper.mjs'
+
+const { npm_old_version: previousVersion, npm_new_version: newVersion } =
+  process.env
+
+if (!previousVersion || !newVersion) {
+  throw new Error('Both previous and new version must be set to continue.')
+}
+
+console.log(
+  `Updating changelog from version ${previousVersion} to ${newVersion}...`
+)
+
+updateChangelog(newVersion, previousVersion)

packages/govuk-frontend/package.json

@@ -63,6 +63,7 @@
     "clean:package": "del-cli *.tsbuildinfo dist govuk-prototype-kit.config.json",
     "clean:release": "del-cli ../../dist --force",
     "postbuild:package": "npm run build:stats && govuk-prototype-kit validate-plugin .",
+    "version": "../../bin/update-changelog.mjs",
     "get-version": "echo $npm_package_version"
   },
   "devDependencies": {