Push to VCS

Push to VCS lets you version a Data Store by storing its latest state in a Git-based version control system, using a commit message to track changes and facilitate collaboration.

Prerequisites:

  • The Data Store has been created and validated.

  • You have permissions to Push the Data Store to the Git repository.

  • VCS integration is set up for version control.

Steps to Push a Data Store to VCS

  • Navigate to the Data Stores list

    • Go to Data Center → Data Stores.

  • Select the Data Store

    • Find the Data Store you wish to push to VCS.

  • Click the Push to VCS icon

    • Click the Push to VCS icon for the selected Data Store.

    Result: The Push into Version Controlling System dialog box appears.

  • Enter a Commit Message

    • Commit message: Provide a meaningful commit message. This message will serve as a label for the version in Git, helping others (and yourself) understand what was changed.

    • Note: The Push option will remain disabled until a commit message is provided.

  • Click Push

    • After entering the commit message, click Push. Result: A confirmation message appears, confirming that the Data Store version has been successfully pushed to the VCS.

Outcome

  • The Data Store is now versioned and stored in the Git repository, with the commit message acting as a version label.

  • You and your team members can now Pull from VCS to retrieve previous versions or collaborate using version-controlled Data Stores.

Notes & Tips:

  • Commit message: This is a required field and is essential for identifying changes. Ensure you include a descriptive message (e.g., "Added filter for region", "Fixed data type mismatch in column X").

  • The Push action only affects the Data Store's definition (query, fields, metadata). It does not affect underlying data or performance (unless changes are made in the Data Store's configuration).

  • Versioning helps track changes over time. Push often after meaningful edits to preserve history.

  • Keep commit messages clear and concise (e.g., "Updated column headers" or "Refined SQL query for performance").

  • Use Pull from VCS to access historical versions, especially if you need to troubleshoot or revert to a previous state.

Troubleshooting

  • Push icon disabled: Ensure a commit message is entered; if the message is provided and the issue persists, check if your VCS credentials are correct or your repository access is valid.

  • Push fails: Confirm that the repository is accessible, and you have write permissions. Review the error message for more specifics.

  • Version not appearing after Push: Refresh the Data Stores list or confirm the correct repository and branch are used for storing the Data Store.

Last updated