4.11.0 Release checklist

[compulim]

Checklist

Build

1. Bump MockBot to Bot Framework SDK release 4.11.0
   • https://www.npmjs.com/package/botbuilder/v/4.11.0
   • We are not bumping for patch release
2. Bump botframework-directlinejs to 0.13.0
   • PR is XXX
   • We did not bump botframework-directlinejs
3. Bump to 4.11.0
   • Update CHANGELOG.md to mark specific changes in 4.11.0
   • Run npm version --no-git-tag-version 4.11.0
   • Merged into master, the PR number is Bump to 4.11.0 #3588
   • Commit is 009a27e
   • 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 181956 and commit is 009a27e

Test

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

1. Manual testing on major browsers using webchat-release-testing
   • Chrome 86.0.4240.111
   • Edge (Anaheim) 86.0.622.56
   • Edge (UWP) 44.20241.1000.1 (EdgeHTML 18.20241)
   • Firefox 82.0.2
   • IE11 (Windows 10 20246.1)
   • macOS Safari 13.1.3 (15609.4.1)
     • 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 14.1
   • Android Chrome 86.0.4240.110
2. Test specific fixes related to 4.11.0 and previous releases
   • Accessibility: screen reader will now read attachment details

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.11.0
4. git log
   • Verify the latest commit is 009a27e
5. git tag v4.11.0
6. git push -u upstream v4.11.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.11.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 5 tarballs
     • You can copy the artifacts from webchat-release-testing/drops
     • Tarballs download from npmjs

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

8. Kick off release to NPM
   • Release name is [[PROD]]Push-WebChat-to-npmjs
   • The build number is 181956, release number is 2532 and commit is 009a27e
   • 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 181956, release number is 2540 and commit is 009a27e
   • Script build number is 131156 (this is fixed)
   1. Send reminder email to approvers
   • Retain the build indefinitely

Post-release check

• 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.11.0 (just install the bundle package)
     4. npm run build
  3. Others
     • Using script tags from https://github.com/microsoft/BotFramework-WebChat/releases/tag/v4.11.0, with subresource integrity

       <script
          crossorigin="anonymous"
          integrity="sha384-vkX1C8fopQ2J+lXKsoiEUWsLnvq9bfoS54SzU4P1iM+AafCMLUL9sbC2NY0ktBnL"
          src="https://cdn.botframework.com/botframework-webchat/latest/webchat-es5.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 partners.md with Web Chat latest release MicrosoftDocs/AdaptiveCards#369
• Notify related parties for the following fixes
  • SDK team
  • Omnichannel
  • Pooja
• Update root README.md with feature notes
• Update R11 Release Checklist botframework-sdk#6086

Changelog

Added

• Resolves #3281. Added documentation on speech permissions for Cordova apps on Android, by @corinagum, in PR #3508
• Resolves #3316. Refactored platform-neutral APIs into the new api package, to be reused on React Native component, in PR #3543 by @compulim
  • The new layering is core -> api -> component (HTML-only) -> bundle
  • Includes composition mode, platform-neutral React hooks, and localization resources
  • Most hooks are available in the new api package. Some hooks are only available on the existing component package, due to their platform dependency or coupling with visual components. For example, Web Worker, 2D canvas, useMicrophoneButton* are not available on the api package
  • Most implementations of middleware are only available in component package due to their coupling with visual components or platform features. Some implementations, (e.g. card action middleware and activity grouping middleware) are available on api package. For example:
    • Carousel layout and stacked layout is only available on component package due to their coupling with their respective visual components
    • For card action middleware, imBack, messageBack and postBack actions are available on api package, but call, openUrl and other platform-dependent actions are only available on component package
  • activityMiddleware, attachmentMiddleware, etc, now support arrays for multiple middleware

Fixed

• Fixes #3489. [Accessibility]: Fix AT saying 'Bot undefined said', by @corinagum in PR #3524
• Fixes #3547. [Accessibility]: Add attachment middleware for screen reader, by @compulim in PR #3548
• Fixes #3371. [Accessibility]: Add alt property for image in HeroCards, by @corinagum in PR #3541
• Fixes #3310. Add quantity, tap and text field to ReceiptCards, by @corinagum in PR #3541
• Fixes #3514. Fix PoliCheck language errors, by @corinagum in PR #3545
• Fixes #3537. [Accessibility]: Ensure aria-roledescription is only used on elements with implicit/explicit role based off of WAI ARIA role attributes, by @corinagum in PR #3551 and #3583
• Fixes #3431. Activities should not be delayed due to missing activity of type "typing", by @compulim in PR #3554
• Fixes #3574. Creates workaround for Cognitive Services Speech SDK 1.13.1 regarding removed support of macOS/iOS, by @compulim in PR #3576
• Fixes #3570. Adaptive Card speak property should be narrated by screen reader, by @compulim in PR #3573 and PR #3584
• Fixes #3571. Error box should be hidden for Adaptive Card renderer when running in production mode, by @compulim in PR #3573

Changed

• Bumped development dependency node-fetch@2.6.1 in PR #3467 by @dependabot
• Bumped Cognitive Services Speech SDK to 1.13.1, by @compulim in PR #3432
  • microsoft-cognitiveservices-speech-sdk@1.13.1

Samples

• Fixes #3526. Add info on composition mode in sample 06.d, by @corinagum in PR #3541

[corinagum]

Closing as complete