Deployment Process

This describes how changes are deployed to Dimagi's own openchatstudio.com. If you're deploying a self-hosted instance elsewhere, see Self-Hosting Open Chat Studio instead.

Continuous Deployment

• All changes merged to the main branch trigger an automated deployment.
• Deployment is only triggered by successful completion of the lint_and_test.yml GitHub workflow.
• Deployment is executed by the deploy.yml GitHub action.

Monitoring Deployments

• Deploy notifications are automatically sent to the #open-chat-studio-dev Slack channel.
• Each notification includes:
  • Build status
  • Changes included in the deployment
  • Deploy completion status

Best Practices

• Always monitor the Slack channels after merging to main.
• Watch for successful completion of your deployment.
• Watch for Sentry errors after deployment.

Rollback Process

• Although rollback is possible, we would prefer to roll forward by deploying a fix to the issue.
• If issues are detected, notify the team in #open-chat-studio-dev.
• Monitor #ocs-ops for any related errors.
• Work with the team to determine the best course of action.