commit
d4ea1a6645
@ -0,0 +1,43 @@ |
|||||||
|
# Sensitive Release Protocol |
||||||
|
|
||||||
|
In the case that a new change is so dramatic that it is hard to anticipate all of the potential side-effects, here is a protocol for rolling out these sensitive changes in a way that: |
||||||
|
|
||||||
|
- Minimizes adverse impact on end users. |
||||||
|
- Maximizes our responsiveness to these changes. |
||||||
|
|
||||||
|
## Protocol Steps |
||||||
|
|
||||||
|
1. Prepare a normal release. |
||||||
|
2. Prepare a rollback release. |
||||||
|
3. Roll the normal release out. |
||||||
|
4. In case of emergency, roll back. |
||||||
|
|
||||||
|
### Normal Release |
||||||
|
|
||||||
|
Simply follow the steps in [the publishing guide](./publishing.md). |
||||||
|
|
||||||
|
### Prepare Rollback Release |
||||||
|
|
||||||
|
1. Check out the tagged commit for the release before this new release. |
||||||
|
2. Increment the version over the new release by one patch. |
||||||
|
3. Merge the changelog of the new release into this branch, and make its own changelog refer to rolling back those changes. |
||||||
|
4. Push to the main repository and pull request against `master` prominently noting this is a `DO NOT MERGE` rollback pull request. |
||||||
|
|
||||||
|
### Roll the normal release out |
||||||
|
|
||||||
|
Ensure the rollback release has been built, and downloaded locally, fully ready to deploy with immediacy. |
||||||
|
|
||||||
|
For a sensitive release, initially roll out to only 1% of Chrome users (since Chrome allows incremental rollout). |
||||||
|
|
||||||
|
Monitor Sentry for any recognizable error logs. |
||||||
|
|
||||||
|
Gradually increase the rollout percentage. |
||||||
|
|
||||||
|
### In case of Emergency |
||||||
|
|
||||||
|
If a problem is detected, publish the roll-back release to 100% of users, identify the issue, fix it, and repeat this process with a new release. |
||||||
|
|
||||||
|
## Summary |
||||||
|
|
||||||
|
This protocol is a worst-case scenario, just a way to be incredibly careful about our most sensitive possible changes. |
||||||
|
|
Loading…
Reference in new issue