Skip to content

Commit 82baa26

Browse files
committed
Update docs with steps to upgrade the version in Dotcom
1 parent bfc2c49 commit 82baa26

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

Diff for: README.md

+23
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,29 @@ npm install
3636
npm test
3737
```
3838

39+
## Upgrading browser-support in Dotcom
40+
41+
Before upgrading the browser-support version in Dotcom, we need to ensure that the current functionality is not broken. One of the things that can go wrong is that the functionality to report browser errors to Sentry can break after upgrading this package. Below is a list of steps you can take to ensure this functionality is not broken.
42+
43+
### Review lab testing
44+
- Create a PR to upgrade the browser-support version in Dotcom.
45+
- Trigger a browser error from your `review-lab` instance and ensure the error is properly reported in Sentry.
46+
- Append the `#b00m` string to your `review-lab` URL and refresh the page.
47+
- Verify that the `b00m` error is properly reported in [Sentry](https://github.sentry.io/issues/?environment=review-lab&groupStatsPeriod=auto&project=1890375&query=b00m&referrer=issue-list&statsPeriod=5m).
48+
- Run the verification steps in Chrome, Firefox, Edge and Opera browsers. There is an [open issue](https://github.com/github/web-systems/issues/3162) where errors are currently not being reported in Safari browsers.
49+
50+
### Production deployment
51+
52+
- Keep an eye to the `browser-reporting` monitor: https://app.datadoghq.com/monitors/168685099
53+
- If the rate of browser erorrs reported drops, the monitor will go off and you will get an alert in the [#web-systems-ops](https://github-grid.enterprise.slack.com/archives/C046W1V95FV) channel
54+
- After the upgrade has deployed to Canary:
55+
- Trigger a browser error by appending th e`#b00m` string to your URL.
56+
- Verify that the `b00m` error is properly reported in [Sentry](https://github.sentry.io/issues/?environment=canary&groupStatsPeriod=auto&project=1890375&query=b00m&referrer=issue-list&statsPeriod=5m).
57+
- After upgrade has deployed to production.
58+
- Trigger a browser error by appending th e`#b00m` string to your URL.
59+
- Verify that the `b00m` error is properly reported in [Sentry](https://github.sentry.io/issues/?environment=canary&groupStatsPeriod=auto&project=1890375&query=b00m&referrer=issue-list&statsPeriod=5m).
60+
- Verify the monitor to ensure the rate of reported errors to Sentry has not dropped: https://app.datadoghq.com/monitors/168685099
61+
3962
## Contributing
4063

4164
### Adding polyfills

0 commit comments

Comments
 (0)