Deployment runbook#

Tip

For more information on how deployments work, please see the general deployment guide.

  1. Publish the drafted API release in the GitHub release page of the monorepo

    • Here you can preview the changes included in the API release and decide whether a release is necessary and adjust monitoring during the deployment accordingly.

  2. That’s it! The API will be deployed. You can monitor the deployment in the maintainers #openverse-notifications channel and in the infrastructure repository’s workflow listing.

Post-deployment steps#

  1. Check for any Sentry errors in the maintainer’s #openverse-alerts channel, or in the Sentry UI.

  2. Visit https://api.openverse.engineering/v1 and verify the SHA is the same as the value you deployed.

  3. Review and Approve the automatically-generated changelog pull request in the repository.

  4. In the event of errors or problems, 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 workflow is the version number prefixed with “rel-”, for example “rel-2023.07.03.17.52.00”.

  5. If anything else goes wrong or service is disrupted, consider this a Production Incident and notify the team.