Deployment runbook#
Tip
For more information on how deployments work, please see the general deployment guide.
Publish the drafted frontend release in the GitHub release page of the monorepo
Here you can preview the changes included in the frontend release and decide whether a release is necessary and adjust monitoring during the deployment accordingly.
That’s it. The frontend will be deployed. You can monitor the deployment in the maintainers
#openverse-notificationschannel and in the infrastructure repository’s workflow listing.
Post-deployment steps#
Check for any Sentry errors in the maintainer’s
#openverse-alertschannel, or in the Sentry UI.Visit https://openverse.org/version.json and verify the SHA is the same as the value you deployed.
Review and Approve the automatically-generated changelog pull request in the repository.
rollback the application by running the appropriate deployment workflow from the WordPress/openverse-infrastructure repository using the tag of the latest stable version. You can find the release version number in the changelogs, and then the tag to pass to the action is the version number prefixed with “rel-”, for example “rel-2023.07.03.17.52.00”.
Add any new analytics events to Plausible:
Visit the “Goals” configuration page and add any new events.
If those events have new unique payload property names, those must also be added to the “Custom properties” configuration.
Warning
Do not click the “click to add all existing properties” button! This button will cause all props to be added and therefore displayed on events, even ones we’ve explicitly removed. Instead, manually add new custom properties one at a time by entering them into the input box on the page. If the event has already been sent once, the property names will auto-complete in the box, making it less tedious to add new ones.
If you accidentally click this button, please manually delete the following deprecated properties from the configuration:
timestamplanguageuaosplatformbrowserversionoriginpathnamereferrer