Skip to main content
Version: Current (3.x)

Data VIZ API

The Data VIZ API Repository is a monorepo that contains the following services:

All the services are built using Docker where each service is a Docker image. The services can be released separately or all at once.

Release Process​

The project uses two GitHub Actions workflows for different types of releases:

  • This is the workflow that is used to release the following services:
    • API Gateway
    • API Security
    • API Registry
    • Superset Proxy

Pre-Release Workflow​

  • Trigger: Automatic on pushes to main branch or manual dispatch
  • Tag Format: v{version}-snapshot-{YYYYMMDD}
  • Docker Tag: v{version}-snapshot-{YYYYMMDD}
  • Purpose: Testing and development. Pushed to the registry.

Visual Representation​

Production Release​

  • Trigger: Manual dispatch only
  • Tag Format: v{version}
  • Docker Tags: latest and v{version}
  • Purpose: Stable production deployment. Pushed to the registry.

Visual Representation​

Releasing Commons Library​

The Commons Library is a library of shared code that is used by the other services.

  • The Commons Library is released using the Pre-Release Workflow.
  • The Commons Library is released using the Production Release Workflow.
  • The commons library is released together with the parent that is used as a maven parent. The parent is released using the Production Release Workflow.