4.10.0 Release checklist

[compulim]

Checklist

Build

1. Bump MockBot to Bot Framework SDK release 4.10.0
   • https://www.npmjs.com/package/botbuilder/v/4.10.0
   • We are not bumping for patch release
2. Bump botframework-directlinejs to 0.13.0
   • PR is [HIGH] [email protected] #3418 and [HIGH] Bump directlinejs in core #3419
3. Bump to 4.10.0
   • Update CHANGELOG.md to mark specific changes in 4.10.0
   • Run npm version --no-git-tag-version 4.10.0
   • Merged into master, the PR number is Bump Web Chat to 4.10.0 #3420
   • Commit is 9b346b8
   • 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 157901 and commit is 9b346b8

Test

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

1. Manual testing on major browsers using webchat-release-testing
   • Chrome 84.0.4147.125
   • Edge (Anaheim) 84.0.522.61
   • Edge (UWP) 44.19041.423.0
   • Firefox 79.0
   • IE11 11.450.19041.0 (11.0.205 KB4571687)
   • macOS Safari 13.1.1 (15609.2.9.1.2)
     • DLSpeech: Web Socket connection to westus2.convai.speech.microsoft.com closed instantly after connected, it also repro on previous versions of Web Chat (failed on 4.9.0, 4.8.1)
       • WebSocket connection immediately closed on macOS cognitive-services-speech-sdk-js#221
   • iOS Safari 13.6.1
   • Android Chrome 84.0.4147.125
2. Test specific fixes related to 4.10.0 and previous releases
   • (N/A) (Look at CHANGELOG.md and list out PRs that were not covered with automated tests)

Release

1. Make sure you are on master or qfe branch, run git status to check
2. git pull
3. Verify /package.json, /package-lock.json, and CHANGELOG.md has a version of 4.10.0
4. git log
   • Verify the latest commit is 9b346b8
5. git tag v4.10.0
6. git push -u upstream v4.10.0
   • 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 CDN: curl -H 'Accept-Encoding: gzip' https://cdn.botframework.com/botframework-webchat/4.10.0/webchat.js | gunzip - | openssl dgst -sha384 -binary | openssl base64 -A
     • From local: cat webchat.js | openssl dgst -sha384 -binary | openssl base64 -A
   • Attach assets including 3 JS files, stats.json and 4 tarballs
     • You can copy the artifacts from webchat-release-testing/drops
     • Tarballs download from npmjs

       curl -L -o botframework-directlinespeech-sdk-4.10.0.tgz https://registry.npmjs.org/botframework-directlinespeech-sdk/-/botframework-directlinespeech-sdk-4.10.0.tgz
       curl -L -o botframework-webchat-4.10.0.tgz https://registry.npmjs.org/botframework-webchat/-/botframework-webchat-4.10.0.tgz
       curl -L -o botframework-webchat-core-4.10.0.tgz https://registry.npmjs.org/botframework-webchat-core/-/botframework-webchat-core-4.10.0.tgz
       curl -L -o botframework-webchat-component-4.10.0.tgz https://registry.npmjs.org/botframework-webchat-component/-/botframework-webchat-component-4.10.0.tgz
       

8. Kick off release to NPM
   • Release name is [[PROD]]Push-WebChat-to-npmjs
   • The build number is 157901, release number is 2442 and commit is 9b346b8
   • Retain the build indefinitely
9. Kick off release to CDN
   1. Prepare the email for approval
   • Release name is [[PROD]]Push-WebChat-to-Prod-CDN-with-approval
   • The build number is 157901, release number is 2443 and commit is 9b346b8
   • Script build number is 131156
   1. Send reminder email to approvers
   • Retain the build indefinitely

Post-release check

• Test using webchat-release-testing
  • Clone https://github.com/corinagum/WebChat-release-testing/
  • 01.create-react-app
    1. Nuke 01.create-react-app/node_modules
    2. npm install [email protected] (just install the bundle package)
  • Others
    • Using script tags from https://github.com/microsoft/BotFramework-WebChat/releases/tag/v4.10.0, with subresource integrity

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

Notification to interested parties

• Update partner page on Adaptive Cards doc
  • https://docs.microsoft.com/en-us/adaptive-cards/resources/partners
  • PR at https://github.com/MicrosoftDocs/AdaptiveCards/pull/XXX
• Notify related parties for the following fixes
  • SDK team
  • Omnichannel
  • Pooja
• Update root README.md with feature notes

Changelog