4.15.1 Release checklist

[compulim]

Checklist

Build

1. Bump MockBot to Bot Framework SDK release 4.15.1 (not needed for patch release)
   • https://www.npmjs.com/package/botbuilder/v/latest
2. Bump botframework-directlinejs to 0.15.1
   • Bumped to 0.15.1 in Bump dependencies #4123
3. Bump to 4.15.1
   • Update CHANGELOG.md to mark specific changes in 4.15.1
   • Run npm version --no-git-tag-version 4.15.1
   • Merged into master, the PR number is Render/mount to a detached DOM node #4197
   • Commit is a6b3788
   • Do not merge any other unrelated changes after this PR. Any other PR merged, will need to be re-tested
4. Run daily pipeline manually, set "generate release version number" to true
   • (This will not push to NPM or CDN)
   • Pipeline name is BotFramework-WebChat-daily
   • The build number is 294611 and commit is a6b3788
5. Wait for WebChat-release-testing pipeline to complete
   • Pipeline name is Push-Release-Testing-to-GitHub-Pages
   • The release ID is 325
6. Check component governance and make sure there are no high/critical related to code under /packages/ folder
   • There could be some for projects under /samples/ folder, as they are pointing to previous version of Web Chat
7. 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 98.0.4758.102
   • Edge 98.0.1108.62
   • Firefox 97.0.1
   • IE11 (Windows 11 22H2 22567.1)
   • macOS Safari 15.3 (17612.4.9.1.8)
   • iOS Safari 15.1
   • Android Chrome 98.0.4758.101
2. Test specific fixes related to 4.15.1 and previous releases
   • Make sure rendering Web Chat on a detached node is working

Release

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

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

9. Kick off release to NPM
   • Release name is [[PROD]]Push-WebChat-to-npmjs
   • The build number is 294611 release number is 38 and commit is a6b3788
   • Verify package content then click Resume
   • Retain the release indefinitely
10. Kick off release to CDN (cutoff at 2PM PST, Mon-Thu only)
    1. Prepare the email for approval
    • Release name is [[PROD]]Push-WebChat-to-Prod-CDN-with-approval
    • The build number is 294611, release number is 42 and commit is a6b3788
    • Script build number is 131156 (this is fixed)
    1. Send reminder email to approvers
    • 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 [email protected] (just install the bundle package)
     4. npm run build
  3. Others
     • Using script tags from https://github.com/microsoft/BotFramework-WebChat/releases/tag/v4.15.1, with subresource integrity

       <script
         crossorigin="anonymous"
         integrity="sha384-e2zspajCn8G7DzOMi/9M6fdAPERyN5S11E5QzrAK0HXxMwyw7a6/FHLie73RUzdD"
         src="https://cdn.botframework.com/botframework-webchat/4.15.1/webchat.js"
       ></script>
       
       <script
         crossorigin="anonymous"
         integrity="sha384-9o6xJEK8DboSm23+cyRi/6ROyiQFbCXgSN+GkpMXVtIC0QeYRPA9lD8MlXPikyub"
         src="https://cdn.botframework.com/botframework-webchat/4.15.1/webchat-es5.js"
       ></script>
       
       <script
         crossorigin="anonymous"
         integrity="sha384-gy9DN+p1zEnZY24LW0HtuFhmhF17qhO8QM0vlrZupIXggEUih+uYAPZ+uGCTT1f7"
         src="https://cdn.botframework.com/botframework-webchat/4.15.1/webchat-minimal.js"
       ></script>
       

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

Notification to interested parties

• Update partner page on Adaptive Cards doc
  • https://docs.microsoft.com/en-us/adaptive-cards/resources/partners
  • PR at Update Web Chat version number MicrosoftDocs/AdaptiveCards#443
• Notify related parties for the following fixes
  • SDK team
  • Omnichannel
  • Pooja/Zhipeng
• Update root README.md with feature notes -- Note: PR will be combined with post-release checklist PR

---

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 master
  • git checkout master
  • git cherry-pick XXX (the commitish for bumping version number and CHANGELOG.md)
• If needed, correct the date for 4.15.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.15.2-0 in PR Bump to 4.15.2-0 #4195
  • Run npm version prepatch --no-git-tag-version
• Update servicingPlan.json in PR Bump to 4.15.2-0 #4195
  • Add deprecation notes for previous versions
  • Subresource integrity hash from https://github.com/microsoft/BotFramework-WebChat/releases/tag/v4.15.1
• Update all samples to use 4.15.1 in PR Bump to 4.15.2-0 #4195
  • 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
  • Create a new folder
  • Run npm init with default values
  • Run npm install [email protected]
  • Look at the result and see if there are any production-hitting vulnerabilities, investigate if needed

The PR is https://github.com/microsoft/BotFramework-WebChat/pull/XXX

Applies to major/minor releases

Bump all dependencies to latest version

• Run npm run bump
• Run npm audit fix to make sure everything is fixed
• Test under IE11 to make sure all dependencies are working
• List steps to verify bumping microsoft-cognitiveservices-speech-sdk

Obstacles to bump npm

Check if the followings are still valid. We should bump to npm@latest ([email protected]) as soon as possible.

As of writing, [email protected] (bundled by node@16) has issue on running postinstall script.

[email protected] is peer-depends on @angular/common, which npm@7 will automatically install missing peer dependencies. Track the issue here.

Bump Docker image

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

• Docker container for headless Chrome (#XXX)
  • They recently moved from 3.14.159-xxx tag scheme to a more sensible 87.0 tag scheme
  • Tags can be found at https://hub.docker.com/r/selenium/node-chrome/tags
  • Preferably in separate PR because screenshots change can be large occasionally
  • Run tests locally, as the screenshots can be slightly different
  • Also consider bumping to Edge-based images