You are browsing a read-only backup copy of Wikitech. The live site can be found at wikitech.wikimedia.org

Difference between revisions of "Deployments/Risky change template"

From Wikitech-static
Jump to navigation Jump to search
imported>Thcipriani
(Better link)
 
imported>Krinkle
 
Line 3: Line 3:
Below is an example template to add as a comment on a Phabricator [[phab:maniphest/query/g9PWXpqLCVP9/#R|train blocker task]] to  alert the deployers that there are risky patches riding the deployment train.
Below is an example template to add as a comment on a Phabricator [[phab:maniphest/query/g9PWXpqLCVP9/#R|train blocker task]] to  alert the deployers that there are risky patches riding the deployment train.


== Example Template ==
== Template ==


<pre>
<pre>
### Risky Patch!  🚂🔥
##### Risky Patch!  🚂🔥


* **Change**:  https://gerrit.wikimedia.org/r/c/mediawiki/extensions/FlaggedRevs/+/585376
* **Change**:  https://gerrit.wikimedia.org/r/0000000
* **What it does/What it's risky**:
* **Summary**:
** there's nothing particularly risky about this one, but it's big and touching a lot of code.
** !! Why is it risky? !!
** FlaggedRevs is not well covered by tests and has a ton of edge cases
* **Test plan**:
* **Test Plan**:
** !! How will it be verified? !!
* **Places to monitor**:
** [Logstash: mediawiki-errors](https://logstash.wikimedia.org/app/kibana#/dashboard/mediawiki-errors)
** [Grafana: mediawiki-errors](https://grafana.wikimedia.org/d/000000438/mediawiki-exceptions-alerts)
* **Revert plan**: !!Rollback train, or Revert patch, or …!!
* **Affected wikis**:
```lines=10
testwiki
test2wiki
```
* **IRC contact**: `your_name`, `someone_else`
* **UBN Task Projects/tags**: #your_team
</pre>
 
== Example ==
 
<table>
<tr><td><pre>
##### Risky Patch!  🚂🔥
 
* **Change**: https://gerrit.wikimedia.org/r/0000000
* **Summary**: (Why is it risky?)
** Big refactor in Foobar.
** Lots of callers to Foobar in extensions that are not all covered by tests.
* **Test plan**:
** FlaggedRevs are enabled on test2wiki. Mostly manual testing unfortunately and log watching.
** FlaggedRevs are enabled on test2wiki. Mostly manual testing unfortunately and log watching.
* **Places to Watch for Breakage**
* **Places to monitor**:
** Logstash MediaWiki Errors Dashboard: https://logstash.wikimedia.org/app/kibana#/dashboard/mediawiki-errors
** [Logstash: mediawiki-errors](https://logstash.wikimedia.org/app/kibana#/dashboard/mediawiki-errors)
** Grafana Production Logging Dashboard: https://grafana.wikimedia.org/d/000000102/production-logging
** [Grafana: mediawiki-errors](https://grafana.wikimedia.org/d/000000438/mediawiki-exceptions-alerts)
* **Revert Plan**: rollback
* **Revert plan**: Rollback train.
* **Wikis Affected**:
* **Affected wikis**:
```lines=10
```lines=10
alswiki
alswiki
Line 24: Line 48:
bewiki
bewiki
bnwiki
bnwiki
bswiki
cawikinews
cewiki
ckbwiki
dewiki
dewiki
dewikiquote
dewiktionary
elwikinews
enwiki
enwiki
enwikibooks
enwikinews
eowiki
eswikinews
fawiki
fawikinews
fiwiki
frwikinews
hewikisource
hiwiki
huwiki
iawiki
idwiki
iswiktionary
kawiki
lawikisource
mkwiki
plwiki
plwikisource
plwiktionary
ptwikibooks
ptwikinews
ptwikisource
ruwiki
ruwikinews
ruwikiquote
ruwikisource
ruwiktionary
sqwiki
tawikinews
test2wiki
trwiki
trwikiquote
ukwiki
ukwiktionary
vecwiki
zh_classicalwiki
```
```
* **IRC Contact**: @Pchelolo or @DannyS712
* **IRC Contact**: `Pchelolo`, `DannyS712`
* **UBN Task Projects/tags**: #core_platform_team
* **UBN Task Projects/tags**: #core_platform_team
</pre>
</pre></td><td valign="top">[[File:RiskyPatch.png|550px|frameless|center]]</td>
 
</tr></table>
[[Image:RiskyPatch.png|800px|frameless|center|middle]]

Latest revision as of 01:48, 14 June 2021

You have a patch that you feel might cause problems on deployment: now what?

Below is an example template to add as a comment on a Phabricator train blocker task to alert the deployers that there are risky patches riding the deployment train.

Template

##### Risky Patch!  🚂🔥

* **Change**:  https://gerrit.wikimedia.org/r/0000000
* **Summary**:
** !! Why is it risky? !!
* **Test plan**:
** !! How will it be verified? !!
* **Places to monitor**:
** [Logstash: mediawiki-errors](https://logstash.wikimedia.org/app/kibana#/dashboard/mediawiki-errors)
** [Grafana: mediawiki-errors](https://grafana.wikimedia.org/d/000000438/mediawiki-exceptions-alerts)
* **Revert plan**: !!Rollback train, or Revert patch, or …!!
* **Affected wikis**:
```lines=10
testwiki
test2wiki
```
* **IRC contact**: `your_name`, `someone_else`
* **UBN Task Projects/tags**: #your_team

Example

##### Risky Patch!  🚂🔥

* **Change**:  https://gerrit.wikimedia.org/r/0000000
* **Summary**: (Why is it risky?)
** Big refactor in Foobar.
** Lots of callers to Foobar in extensions that are not all covered by tests.
* **Test plan**:
** FlaggedRevs are enabled on test2wiki. Mostly manual testing unfortunately and log watching.
* **Places to monitor**:
** [Logstash: mediawiki-errors](https://logstash.wikimedia.org/app/kibana#/dashboard/mediawiki-errors)
** [Grafana: mediawiki-errors](https://grafana.wikimedia.org/d/000000438/mediawiki-exceptions-alerts)
* **Revert plan**: Rollback train.
* **Affected wikis**:
```lines=10
alswiki
arwiki
bewiki
bnwiki
dewiki
enwiki
```
* **IRC Contact**: `Pchelolo`, `DannyS712`
* **UBN Task Projects/tags**: #core_platform_team
RiskyPatch.png