Skip to main content
Novu operates in a multi environment setup, with the currently available environments:
  • Local - Running against your local machine, this is where you can create, edit, and preview workflows. Open it by running npx novu dev, which opens the Dashboard in Local mode connected to your running app through a tunnel.
  • Development - Acts as a Staging environment, where your non-technical peers can view and modify controls.
  • Production - For triggering workflows to your customers.

​
Sync changes to Novu Cloud

Novu Framework operates in a GitOps model. This means that the source of truth for your workflows and configurations are located in your Git as Code. The Local environment only reflects what runs on your machine - it has no publish action. To make workflows available in Development or Production, deploy your Bridge application and run the sync command against the deployed server from your CLI or CI pipeline.
A Framework workflow cannot use the identifier of a workflow that was created in the Dashboard. Sync fails with Workflow <workflowId> was already created in Dashboard. Please use another workflowId. It does not convert or overwrite the Dashboard workflow.To migrate, create the Framework workflow with a new identifier, sync and test it, then update your application to trigger the new identifier. Deleting the Dashboard workflow first makes its identifier available, but introduces a period when triggers cannot resolve the workflow. Subscriber preferences associated with the deleted workflow are not transferred to the newly created Framework workflow.
The general workflow for pushing changes to Novu Cloud is as follows:
  • Create a feature branch
  • Develop workflows locally in your bridge application
  • Sync changes to the Development environment to test e2e
  • Merge the feature branch to your dev branch
    • This will trigger a CI/CD pipeline that will deploy the changes to the Development environment
  • Test the changes in the Development environment
  • Merge the dev branch to the main branch
    • This will trigger a CI/CD pipeline that will deploy the changes to the Production environment

​
CI/CD Integrations

Novu currently supports the following CI integrations:
Direct integration with other CI/CD tools is on our roadmap. If you would like to see a specific CI/CD tool integrated, please reach out to us.