4.13.0 release checklist #3826

corinagum · 2021-03-31T17:36:38Z

Checklist

Build

~~Bump MockBot to Bot Framework SDK release 4.13.0~~
- https://www.npmjs.com/package/botbuilder/v/4.13.0
- (We will not bump for patch release)
~~Bump botframework-directlinejs to 0.14.1~~
- No newer version
Bump to 4.13.0
- Update CHANGELOG.md to mark specific changes in 4.13.0
- Run npm version --no-git-tag-version 4.13.0
- Merged into master, the PR number is 4.13.0 release bump #3827
- Commit is 585da0a
- Do not merge any other unrelated changes after this PR. Any other PR merged, will need to be re-tested
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 230592 and commit is 585da0a
Wait for WebChat-release-testing pipeline to complete
- Pipeline name is Push-Release-Testing-to-GitHub-Pages
- The release ID is 2697
Add manual tests to WebChat-release-testing as needed

Test

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

Release

Verify on WebChat-release-testing
Make sure you are on master ~~or qfe~~ branch, run git status to check
git pull
Verify /package.json, /package-lock.json, and CHANGELOG.md has a version of 4.13.0
git log
- Verify the latest commit is 585da0a
git tag v4.13.0
git push -u upstream v4.13.0
- You do not need to kick off a build again, use the previous build

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.13.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.13.0.tgz https://registry.npmjs.org/botframework-directlinespeech-sdk/-/botframework-directlinespeech-sdk-4.13.0.tgz
curl -L -o botframework-webchat-4.13.0.tgz https://registry.npmjs.org/botframework-webchat/-/botframework-webchat-4.13.0.tgz
curl -L -o botframework-webchat-core-4.13.0.tgz https://registry.npmjs.org/botframework-webchat-core/-/botframework-webchat-core-4.13.0.tgz
curl -L -o botframework-webchat-api-4.13.0.tgz https://registry.npmjs.org/botframework-webchat-api/-/botframework-webchat-api-4.13.0.tgz
curl -L -o botframework-webchat-component-4.13.0.tgz https://registry.npmjs.org/botframework-webchat-component/-/botframework-webchat-component-4.13.0.tgz

Kick off release to NPM
- Release name is [[PROD]]Push-WebChat-to-npmjs
- The build number is 230592 release number is 32 and commit is 585da0a
- Retain the build indefinitely
Kick off release to CDN (CDN CUTOFF TIME IS 2PM PST)
1. Prepare the email for approval
- Release name is [[PROD]]Push-WebChat-to-Prod-CDN-with-approval
- The build number is 230592, release number is 11 and commit is abc123
- Script build number is 131156 (this is fixed)
1. Send reminder email to approvers
- Retain the build indefinitely

Post-release verification - complete within 30mins / 1hr of the release

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.13.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.13.0, with subresource integrity
```
<script
   crossorigin="anonymous"
   integrity="sha384-"
   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 Updating Web Chat to 4.13.0 MicrosoftDocs/AdaptiveCards#381
Notify related parties for the following fixes
- SDK team
- Omnichannel
- Pooja
Update root README.md with feature notes -- Note: PR will be combined with post-release checklist PR
Update R13 Release Checklist botframework-sdk#6245

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)~~
Correct the date for 4.13.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.13.1-0
- Run npm version prepatch --no-git-tag-version
Update servicingPlan.json
- Add deprecation notes for previous versions
- Subresource integrity hash from https://github.com/microsoft/BotFramework-WebChat/releases/tag/v4.13.0
Update all samples to use 4.13.0
- 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) in PR Bump deps and to 4.13.1-0 #3831
- 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
    - Keep the following dependencies because their latest version requires webpack@5
      - copy-webpack-plugin@6
      - html-webpack-plugin@4
  - microsoft-cognitiveservices-speech-sdk
  - adaptivecards
    - We will bump it in independent PR
  - expect@25
    - The newer version requires Node.js (graceful-fs)
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)

The text was updated successfully, but these errors were encountered:

corinagum · 2021-04-05T21:15:49Z

https://github.com/microsoft/BotFramework-WebChat/releases/tag/v4.13.0

corinagum added the release Release checklist label Mar 31, 2021

corinagum self-assigned this Mar 31, 2021

corinagum mentioned this issue Mar 31, 2021

4.13.0 release bump #3827

Merged

This was referenced Apr 6, 2021

Bump deps and to 4.13.1-0 #3831

Merged

R13 Release Checklist microsoft/botframework-sdk#6245

Closed

corinagum closed this as completed Apr 22, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

4.13.0 release checklist #3826

4.13.0 release checklist #3826

corinagum commented Mar 31, 2021 •

edited by compulim

Loading

corinagum commented Apr 5, 2021

4.13.0 release checklist #3826

4.13.0 release checklist #3826

Comments

corinagum commented Mar 31, 2021 • edited by compulim Loading

Checklist

Build

Test

Release

Post-release verification - complete within 30mins / 1hr of the release

Notification to interested parties

Post-release checklist

Applies to all releases

Applies to major/minor releases

Bump all dependencies to latest version

Bump Docker image

corinagum commented Apr 5, 2021

corinagum commented Mar 31, 2021 •

edited by compulim

Loading