Syncing

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.

The general workflow for pushing changes to Novu Cloud is as follows:

flowchart TB
    localStudio[Local development] --> featureBranch[Feature Branch]
    featureBranch --> syncDev[Sync to Development]
    syncDev --> testDev[Test in Development]
    testDev --> mergeDev[Merge to dev branch]
    mergeDev --> cicdDev[CI/CD deploy to Development]
    cicdDev --> verifyDev[Verify changes]
    verifyDev --> mergeMain[Merge to main branch]
    mergeMain --> cicdProd[CI/CD deploy to Production]
    cicdProd --> prodEnv[Production Environment]

• 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:

• GitHub Actions - Direct Integration
• GitLab CI - Using our CLI command
• Jenkins - Using our CLI command
• CircleCI - Using our CLI command
• Bitbucket Pipelines - Using our CLI command
• Azure DevOps - Using our CLI command
• Travis CI - Using our CLI command
• Other - For any other CI/CD tool, you can use our CLI command