4.9.2 Release checklist

[compulim]

Checklist

Build

1. Bump MockBot to Bot Framework SDK release 4.9.2
   • https://botbuilder.myget.org/feed/botbuilder-v4-js-daily/package/npm/botbuilder
   • https://www.npmjs.com/package/botbuilder/v/4.9.2
   • We are not bumping for patch release
2. Update CHANGELOG.md to mark specific changes in 4.9.2
3. Run npm version --no-git-tag-version 4.9.2
   • Merged into master, the PR number is Update CHANGELOG.md for 4.9.2 release #3304
   • Commit is e0b9ccc
   • 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 146184 and commit is e0b9ccc

Test

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

1. Manual testing on major browsers using webchat-release-testing
   • Chrome 83.0.4103.116
   • Edge (Anaheim) 83.0.478.61
   • Edge (UWP) 44.18362.449.0
   • Firefox 78.0.2
   • IE11
   • macOS Safari 13.0.3 (15608.3.10.1.4)
     • Update version number
     • 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)
       • As it also repro on 4.9.0 and 4.8.1, I think this is service-side issue
   • iOS Safari 13.4.1
     • Update version number
   • Android Chrome 83.0.4103.96
     • Update version number
2. Test specific fixes related to 4.9.2 and previous releases
   • (Look at CHANGELOG.md and list out PRs that were not covered with automated tests)
   • #3265 Fix microphone button styling regression #3276
   • Fix post-4.9.1 accessibility issues #3287

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.9.2
4. git log
   • Verify the latest commit is e0b9ccc
5. git tag v4.9.2
6. git push -u upstream v4.9.2
   • 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.9.2/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.9.2.tgz https://registry.npmjs.org/botframework-directlinespeech-sdk/-/botframework-directlinespeech-sdk-4.9.2.tgz
       curl -L -o botframework-webchat-4.9.2.tgz https://registry.npmjs.org/botframework-webchat/-/botframework-webchat-4.9.2.tgz
       curl -L -o botframework-webchat-core-4.9.2.tgz https://registry.npmjs.org/botframework-webchat-core/-/botframework-webchat-core-4.9.2.tgz
       curl -L -o botframework-webchat-component-4.9.2.tgz https://registry.npmjs.org/botframework-webchat-component/-/botframework-webchat-component-4.9.2.tgz
       

8. Kick off release to NPM
   • Release name is [[PROD]]Push-WebChat-to-npmjs
   • The build number is 146184, release number is 2384 and commit is e0b9ccc
   • 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 146184, release number is 2389 and commit is e0b9ccc
   • 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.9.2, 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 Update Web Chat to 4.9.2 MicrosoftDocs/AdaptiveCards#308
• Notify related parties for the following fixes
  • CDC
  • OC
  • Pooja

Changelog

Added

• Resolves #3182. Added stacked suggested actions height properties, by @corinagum, in PR #3235
• Localized strings in Cantonese (yue), by @compulim, in PR #3289

Fixes

• Fixes #3265. Fix styling specificity regression on microphone button, by @corinagum in PR #3276
• Fixes #3279. Fix relative timestamp errored out when showing a time before yesterday, by @compulim in PR #3282
• Fixes #3236, by @compulim in PR #3287
  • Isolated screen reader only live region for incoming activities and added a new <ScreenReaderActivity> component
  • Removed screen reader text for activities outside of live region, including <CarouselFilmstrip>, <StackedLayout>, <TextContent>, and <Timestamp>
  • Updated some accessibility texts
  • Rectified activities render order by delaying activities with replyToId that reference an activity which is not ACK-ed, for up to 5 seconds
  • Disabled widgets will have tabindex="-1" set, instead of disabled attribute
  • Remove tabindex="-1" from Adaptive Cards container
  • Hide activities of type invoke
• Fixes #3294. Fix blank screen on missing middlewares, by @compulim in PR #3295
• Fixes #3297. Fix className prop is not honored in <ReactWebChat>, by @compulim in PR #3300

Samples

• Resolves #3218 and #2811. Adds documentation on reconnecting to a conversation in minimizable sample, by @corinagum, in PR #3239

[corinagum]

Closing as complete.