4.17.1 Release checklist

[compulim]

Checklist

Build

1. Bump MockBot to latest Bot Framework SDK release (not needed for patch release)
   • https://www.npmjs.com/package/botbuilder/v/latest
2. Bump botframework-directlinejs to 0.15.5 in PR #XXX
3. Update README.md with feature notes
4. Bump to 4.17.1
   • Update CHANGELOG.md to mark specific changes in 4.17.1
   • Run npm version --no-git-tag-version 4.17.1
   • Merged into v4.17.1-qfe, the PR number is [QFE] Bump version number to 4.17.1 #5524
   • Commit is f097f7e
   • Do not merge any other unrelated changes after this PR. Any other PR merged, will need to be re-tested
5. Run official build pipeline manually, set "Generate_Prod_Version_Number" to true
   • (This will not push to NPM or CDN)
   • Pipeline name is BotFramework-WebChat-Official
   • The build number is 413231 and commit is f097f7ea
6. Run or wait for BotFramework-WebChat-Release-Testing pipeline to complete
   • The build ID is 413232
7. Wait for WebChat-release-testing pipeline to complete
   • The release ID is 587
8. Check component governance and make sure there are no high/critical related to code under /packages/ folder (We are on QFE)
   • There could be some for projects under /samples/ folder, as they are pointing to previous version of Web Chat
9. Add manual tests to WebChat-release-testing as needed

Test

The test should run against the build artifacts from Azure Pipelines.

1. Manual testing on major browsers using webchat-release-testing
   • Before starting testing, update all the browser version to latest
   • Chrome 138.0.7204.159
   • Edge 138.0.3351.95
   • Firefox 141.0
   • IE11 (Windows 11 22H2 23531.1001)
   • macOS Safari 18.5 (xxxxx.x.xx.xxx.x)
   • iOS Safari 18.5 (22F76)
   • iPadOS Safari 18.5 (22F76)
   • Android Chrome 138.0.7204.157
2. Test specific fixes related to 4.17.1 and previous releases
   • Keyboard help screen should be removed

Note: when the bot is sending a long message (say, markdown) via Direct Line Speech, the service may kill the connection. This is an issue on Direct Line Speech service and is not an issue about Web Chat.

Release

1. Make sure you are on main or qfe branch, run git status to check
2. git pull -ff
3. Verify /package.json, /package-lock.json, and CHANGELOG.md has a version of 4.17.1
4. git log
   • Verify the latest commit is f097f7e
5. git tag v4.17.1
6. git push -u upstream v4.17.1
   • You do not need to kick off a build again, use the previous build
7. Create a new GitHub release
   • Copy entries from CHANGELOG.md
   • Subresource Integrity can be generated by
     • From local: for file in $(ls *.js); do echo $file $(cat $file | openssl dgst -sha384 -binary | openssl base64 -A); done
     • From CDN: curl -H 'Accept-Encoding: gzip' https://cdn.botframework.com/botframework-webchat/4.17.1/webchat.js | gunzip - | openssl dgst -sha384 -binary | openssl base64 -A
   • Attach assets including 3 JS files, stats.json and 6 tarballs
     • You can copy the artifacts from the BotFramework-WebChat-Official build
     • Tarballs download from npmjs

       curl -LO https://registry.npmjs.org/botframework-directlinespeech-sdk/-/botframework-directlinespeech-sdk-4.17.1.tgz
       curl -LO https://registry.npmjs.org/botframework-webchat/-/botframework-webchat-4.17.1.tgz
       curl -LO https://registry.npmjs.org/botframework-webchat-core/-/botframework-webchat-core-4.17.1.tgz
       curl -LO https://registry.npmjs.org/botframework-webchat-api/-/botframework-webchat-api-4.17.1.tgz
       curl -LO https://registry.npmjs.org/botframework-webchat-component/-/botframework-webchat-component-4.17.1.tgz
       

8. Kick off release to NPM
   • Release name is [[PROD]]Push-WebChat-Official-to-npmjs
   • The build number is 413231 release number is 4 and commit is f097f7ea
   • Verify package content then click Resume
   • Retain the release indefinitely
9. Kick off release to CDN (cutoff at 10 PM PST, Sun-Wed only)
   1. Prepare the message for approval
      • If there are any breaking changes, explain in the email if it will affect any customers
      • Release name is [[PROD]]Push-WebChat-Official-to-Prod-CDN-with-approval
      • The build number is 413231, release number is 6 and commit is f097f7ea
      • Script build number is 320590 (this is fixed)
   2. Send message to approvers
   3. Retain the build indefinitely

Post-release verification - complete within 30 minutes after release to NPM

• Test using webchat-release-testing
  1. Clone https://github.com/corinagum/WebChat-release-testing/
  2. 01.create-react-app
     1. Nuke 01.create-react-app/node_modules
     2. npm install
     3. npm install botframework-webchat@4.17.1
     4. npm install botframework-webchat-fluent-theme@4.17.1
     5. npm run build
     6. Repeat for 06.esbuild
     7. Repeat for 07.a.webpack4-cjs
     8. Repeat for 07.b.webpack4-esm
     9. Repeat for 08.webpack5
  3. Others
     • Using script tags from https://github.com/microsoft/BotFramework-WebChat/releases/tag/v4.17.1, with subresource integrity

       <script
          crossorigin="anonymous"
          integrity="sha384-"
          src="https://cdn.botframework.com/botframework-webchat/4.17.1/webchat.js"
       ></script>
       
       <script
          crossorigin="anonymous"
          integrity="sha384-"
          src="https://cdn.botframework.com/botframework-webchat/4.17.1/webchat-es5.js"
       ></script>
       
       <script
          crossorigin="anonymous"
          integrity="sha384-"
          src="https://cdn.botframework.com/botframework-webchat/4.17.1/webchat-minimal.js"
       ></script>

  4. npx serve (at repo root)
  5. Go to http://localhost:5000/ to test

Notification to interested parties

• Update partner page on Adaptive Cards doc (Not updating for QFE)
  • https://docs.microsoft.com/en-us/adaptive-cards/resources/partners
  • PR at Update to Web Chat 4.18.0 with AC schema 1.6 MicrosoftDocs/AdaptiveCards#548
• Notify related parties for the following fixes
  • Azure Bot Services
  • Omnichannel
  • Copilot Studio

---

Post-release checklist

These are chores that we should do before starting the cycle to reduce ripple effects if we do it in mid-cycle.

Tips:

• Clean your repo before start
• Remove node_modules from all folder
  • git clean -fdx
• Never delete package-lock.json
• If you mess it up, tableflip and redo
• In component/package.json
  • Remove reference to botframework-webchat-core by hand-modifying package.json
  • Then, npm install (symlinks will be broken afterward)
  • Then, add those references back by hand-modifying package.json
  • This also applies for other packages with similar dependencies/symlinks
  • To build afterward, do tableflip to rebuild those symlinks

Applies to all releases

This list should be copied to versions in the future.

• If on QFE branch, make sure CHANGELOG.md and version number bump is cherry-picked to main
  • git checkout main
  • git cherry-pick XXX (the commitish for bumping version number and CHANGELOG.md)
• If needed, correct the date for 4.17.1 in CHANGELOG.md in PR #XXX
  • There could be last minute fixes that could push the planned date later than the one in CHANGELOG.md
• Bump package.json to 4.18.1-0 in PR Bump to 4.18.1-0 #5242
  • Run npm version prepatch --no-git-tag-version
• Update servicingPlan.json in PR Add 4.17.1 to servicingPlan.json #5525
  • Add deprecation notes for previous versions
  • Subresource integrity hash from https://github.com/microsoft/BotFramework-WebChat/releases/tag/v4.17.1
• Update all samples to use 4.17.1 in PR #XXXX
  • Some samples are pointing to GitHub Releases because the sample need new features from daily build
  • Search "https://github.com/microsoft/BotFramework-WebChat/releases/download/"
    • And replace with "https://cdn.botframework.com/botframework-webchat/latest/"
• Clean up unnecessary branch on official repo
• Understand production-hitting vulnerabilities (This is QFE)
  • Create a new folder
  • Run npm init with default values
  • Run npm install botframework-webchat@4.17.1 botframework-webchat-fluent-theme@4.17.1
  • Look at the result and see if there are any production-hitting vulnerabilities, investigate if needed
    • No vulnerabilities found
• Bump in Copilot Studio (This is QFE)
• Update accessibility conformance report (This is QFE)
  • For any accessibility bugs resolved, remove them from external notes
  • Update version number and publish date

Applies to major/minor releases

Bump all dependencies to latest version

In PR #5174, we are bumping most dependencies to latest version.

After bumping, if a package broke compatibility, we should investigate:

• Upgrade our code to use the latest package if possible, otherwise;
• Add it to package.json/pinDependencies to prevent bumping deliberately
  • Pinning dependencies incur unpredictable technical debts, say, security issue found in the unsupported version, causing us slow to react
  • Every time we bump, we need to go through the whole pinDependencies list

• Run npm run bump
• Run npm audit fix to make sure everything is fixed
• List steps to verify bumping microsoft-cognitiveservices-speech-sdk

Bump Docker image

The Docker image can be found at root docker-compose.yml and Dockerfile*.

• Docker container for headless Chrome in PR #XXXX