feat(ci): support newChange, createRelease/changelogs, pre-release changelogs for multiple ext (#4701)

* feat(ci): support newChange, createRelease/changelogs, pre-release changelogs for multiple ext

- Pre-releases on GitHub with both extension artifacts will now have both recent changelogs in the description.
- newChange and createRelease work on the individual extensions now, and must be accessed with e.g. -w packages/toolkit instead of running at root.
- Release pipeline will call the target extension's createRelease script.

TODO:
- When we release, the "latest" will just refer the last extension that was released. Maybe we should have custom tags if possible.

* add migration newChange, createRelease to root npm scripts

* add comment

* unneeded var

* Update .github/workflows/release.yml

Co-authored-by: Justin M. Keyes <[email protected]>

---------

Co-authored-by: Justin M. Keyes <[email protected]>

Author: hayemaxi

.github/workflows/release.yml

@@ -49,9 +49,9 @@ jobs:
                   echo "FEAT_NAME=" >> $GITHUB_ENV
                   echo "TAG_NAME=prerelease" >> $GITHUB_ENV
             - run: npm ci
-            - name: vsix # TODO: For packages/toolkit release only
+            - name: vsix
               run: |
-                  npm run createRelease  # Generate CHANGELOG.md
+                  npm run createRelease -w packages/toolkit -w packages/amazonq  # Generate CHANGELOG.md
                   npm run -w packages/toolkit package -- --feature "$FEAT_NAME"
                   npm run -w packages/amazonq package -- --feature "$FEAT_NAME"
             - uses: actions/upload-artifact@v4
@@ -62,11 +62,18 @@ jobs:
             - name: Export outputs
               id: build
               run: |
+                  write_package_info() {
+                      PKG_NAME=$1
+                      PKG_DISPLAY_NAME=$(grep -m 1 displayName packages/${PKG_NAME}/package.json | grep -o '[a-zA-z][^\"]\+' | tail -n1)
+                      echo "version=$(grep -m 1 version packages/${PKG_NAME}/package.json | grep -o '[0-9][^\"]\+' | sed 's/-SNAPSHOT//')" >> $GITHUB_OUTPUT
+                      echo "${PKG_NAME}_changes<<EOF" >> $GITHUB_OUTPUT
+                      # Add extension display name to the topmost changelog section.
+                      cat packages/${PKG_NAME}/CHANGELOG.md | perl -ne 'BEGIN{$/="\n\n"} print; exit if $. == 2' | sed -e "1 s/## /## ${PKG_DISPLAY_NAME} - /" >> $GITHUB_OUTPUT
+                  }
                   echo "feature=$FEAT_NAME" >> $GITHUB_OUTPUT
                   echo "tagname=$TAG_NAME" >> $GITHUB_OUTPUT
-                  echo "version=$(grep -m 1 version packages/toolkit/package.json | grep -o '[0-9][^\"]\+' | sed 's/-SNAPSHOT//')" >> $GITHUB_OUTPUT
-                  echo 'changes<<EOF' >> $GITHUB_OUTPUT
-                  cat CHANGELOG.md | perl -ne 'BEGIN{$/="\n\n"} print; exit if $. == 2' >> $GITHUB_OUTPUT
+                  write_package_info toolkit
+                  write_package_info amazonq
                   echo 'EOF' >> $GITHUB_OUTPUT
 
     publish:
@@ -83,7 +90,8 @@ jobs:
             # Used in release_notes.md
             BRANCH: ${{ github.ref_name }}
             # Used in release_notes.md
-            AWS_TOOLKIT_CHANGES: ${{ needs.package.outputs.changes }}
+            AWS_TOOLKIT_CHANGES: ${{ needs.package.outputs.toolkit_changes }}
+            AMAZON_Q_CHANGES: ${{ needs.package.outputs.amazonq_changes }}
         permissions:
             contents: write
         steps:

.github/workflows/release_notes.md

@@ -38,7 +38,6 @@ packages/core/src/testFixtures/**/bin
 packages/core/src/testFixtures/**/obj
 
 # Generated by copyFiles.ts
-packages/*/CHANGELOG.md
 packages/*/LICENSE
 packages/*/NOTICE
 packages/toolkit/package.nls.json

.gitignore

@@ -26,7 +26,7 @@ phases:
         commands:
             - export HOME=/home/codebuild-user
             # Generate CHANGELOG.md
-            - npm run createRelease
+            - npm run createRelease -w packages/toolkit -w packages/amazonq
             - npm run package -w packages/toolkit -w packages/amazonq
 
 artifacts:

buildspec/packageTestVsix.yml

@@ -26,9 +26,8 @@ phases:
                 npm version --no-git-tag-version "$VERSION" -w packages/${TARGET_EXTENSION}
                 # Call npm ci because 'createRelease' uses ts-node
                 npm ci
-            # TODO: fix createRelease (generates CHANGELOG) for "amazonq".
             - |
-                echo "$CODEBUILD_WEBHOOK_HEAD_REF" | >/dev/null grep master && npm run createRelease || true
+                npm run createRelease -w packages/${TARGET_EXTENSION}
             - |
                 git add packages/${TARGET_EXTENSION}/package.json
                 git add package-lock.json

buildspec/release/10changeversion.yml

@@ -30,8 +30,8 @@
         "testE2E": "npm run testE2E -w packages/ --if-present",
         "testInteg": "npm run testInteg -w packages/ --if-present",
         "package": "npm run package -w packages/toolkit",
-        "newChange": "ts-node ./scripts/newChange.ts",
-        "createRelease": "ts-node ./scripts/createRelease.ts",
+        "newChange": "echo 'Must specify subproject/workspace with -w packages/<subproject>' && false",
+        "createRelease": "echo 'Must specify subproject/workspace with -w packages/<subproject>' && false",
         "format": "prettier --check plugins && npm run format -w packages/ --if-present",
         "formatfix": "prettier --write plugins && npm run formatfix -w packages/ --if-present",
         "lint": "npm run lint -w packages/ --if-present && npm run format",

docs/arch_develop.md

@@ -20,7 +20,6 @@
 !package.json
 !package.nls.json
 
-# Automatically copied from root project directory
 !quickStart**
 !README.**
 !CHANGELOG.md

package.json

@@ -27,14 +27,16 @@
         "generateNonCodeFiles": "ts-node ../../scripts/generateNonCodeFiles.ts",
         "copyFiles": "ts-node ./scripts/build/copyFiles.ts",
         "syncPackageJson": "ts-node ./scripts/build/syncPackageJson.ts",
-        "clean": "ts-node ../../scripts/clean.ts dist/ LICENSE NOTICE CHANGELOG.md",
+        "clean": "ts-node ../../scripts/clean.ts dist/ LICENSE NOTICE",
         "compile": "npm run clean && npm run buildScripts && webpack --mode development",
         "package": "ts-node ../../scripts/package.ts",
         "format": "prettier --ignore-path ../../.prettierignore --check src scripts",
         "formatfix": "prettier --ignore-path ../../.prettierignore --write src scripts",
         "lint": "echo 'Nothing to lint yet!'",
         "watch": "npm run clean && npm run buildScripts -- --vueHr && tsc -watch -p ./",
-        "serve": "webpack serve --config-name mainServe --mode development"
+        "serve": "webpack serve --config-name mainServe --mode development",
+        "newChange": "ts-node ../../scripts/newChange.ts",
+        "createRelease": "ts-node ../../scripts/createRelease.ts"
     },
     "dependencies": {
         "aws-core-vscode": "file:../core/"