Versioning

The Version Control option in BDB enables administrators and developers to integrate supported modules with external version control systems (VCS) such as GitLab or GitHub. This simplifies the process of tracking changes, enhances collaboration, and ensures efficient code management.

With Version Control enabled, users can:

  • Push component versions to a GitLab or GitHub repository.

  • Pull a specific version from the repository when needed.

  • Maintain a complete version history for supported modules.

Supported Modules

The following modules support version control integration:

  • Dataset

  • Data as API

  • Data Store

  • Dashboard

  • DS Lab (Project & Notebook)

  • Pipeline Script

Access Version Control Settings

  1. From the Admin Module, select New Version Control under the Configurations list.

    • The Version Control Information form opens.

Configure Version Control

  1. Select Version Option: Choose the desired version configuration from the first drop-down list.

  2. Select a Module: Pick a supported module (e.g., Dashboard).

  3. Select Git Type: Choose GitLab or GitHub.

  4. Provide Host Information: Enter the Git host details.

  5. Provide Token Key: Add the authentication token.

  6. Click Test to verify authentication.

    • A success message appears if authentication is valid.

  7. Select Project: Choose the project within the repository.

  8. Select Branch: Specify the branch where files should be stored.

  9. Configure More Information Fields:

    • Entity App

    • Workspace Name

    • Entity Extension

    • Entity Type

  10. Click Test again to validate all configuration details.

    • A success notification confirms successful authentication.

  11. Click Save.

    • A confirmation message appears, and the configuration for Version Control is saved.

Notes

  • Users must configure the associated module settings for each component separately.

  • Configuration fields may vary depending on the Select field and Token Type information.

Last updated