Deployment runbook#

Tip

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

  1. Visit https://staging.openverse.org/version.json and the frontend Docker image. Verify that the commit SHA live on the staging site is also tagged with latest in the Docker image. GitHub package directory screenshot

  2. Release the app via GitHub workflow. Click the “Run workflow” button, choose “frontend” from the dropdown, and supply the SHA identified in step 1.

  3. That’s it. The frontend 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://openverse.org/version.json 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, repeat the deployment process using the latest stable version of the application. 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”.

  5. Add any new analytics events to Plausible:

    1. Visit the “Goals” configuration page and add any new events.

    2. 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:

    • timestamp

    • language

    • ua

    • os

    • platform

    • browser

    • version

    • origin

    • pathname

    • referrer