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)
• Correct the date for 4.12.0 in CHANGELOG.md
  • There could be last minute fixes that could push the planned date later than the one in CHANGELOG.md
• Bump package.json to 4.12.2-0
  • Run npm version prepatch --no-git-tag-version
  • The PR number is #XXX
• Update servicingPlan.json
  • Add deprecation notes for previous versions
  • Subresource integrity hash from https://github.com/microsoft/BotFramework-WebChat/releases/tag/v4.12.1
  • The PR is #XXX
• Update all samples to use 4.12.1
  • 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/"
  • The PR is https://github.com/microsoft/BotFramework-WebChat/pull/XXX

Applies to major/minor releases

Bump all dependencies to latest version

On each package.json under root and /packages/:

• All NPM packages (@babel/*, jest, lerna, typescript, webpack, etc) (#XXX)
  • Don't bump the following packages
    • react, react-dom, redux, redux-saga, react-film, react-scroll-to-bottom, react-say, react-dictate-button, @types/react
    • remark and strip-markdown, source-map-loader (because of webpack)
      • Newer remark don't work under IE11
      • Please go to the their repos and see if this is fixed or by design
    • sanitize-html@1
      • Starting from version 2, they included nanoid deps which does not work in ES5 environment
      • compulim: Seems sanitize-html removed nanoid from their dependencies, please try to bump it. We use sanitize-html while rendering Markdown
    • serve
    • rxjs on playground
    • webpack@4
      • Starting from version 5, they dropped Node.js polyfills for browsers
      • Please file an issue: Bump webpack@5
      • The issue is #XXX
    • microsoft-cognitiveservices-speech-sdk
• Run npm audit fix to make sure everything is fixed
• Test under IE11 to make sure all dependencies are working

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
• Note on 11/10/2020: 4.0.0-alpha-7-prerelease-20200907 is still prerelease; therefore not bumping (corinagum)