Deploying Changes
Deploy your content changes with zero downtime.
Overview
Deploying data in Basilisk involves creating Data Builds from your Data Sources (Google Spreadsheets) and publishing them to Environments. Data Builds are immutable binary files that can be fetched by your application.
Creating a Data Build
To create a Data Build in the Web Console:
- Navigate to the Data Builds section
- Click "Create New Data Build"
- Select your Data Source (Google Spreadsheet)
- Choose the Basilisk Definition to use (or use the environment's assigned definition)
- Provide a Build ID (or use the default from naming convention)
- Add a description of what the build contains
- Optionally set the log level for build execution
- Start the build process
The build process will:
- Create a backup snapshot of your spreadsheet
- Validate the data against your Basilisk Definition
- Process and serialize the data into Protocol Buffer format
- Generate the immutable Data Build file
Build Execution
During build execution, you can monitor the progress in real-time. The system will:
- Show validation progress
- Display any errors or warnings
- Provide execution logs based on the configured log level
If the build fails, review the error logs to identify and fix issues in your data source or definition.
Build Results
After a build completes, you'll see:
- Build Status: SUCCESS, FAIL, or IN PROGRESS
- Build ID: Unique identifier for the build
- Build Date and Time: When the build was created
- Backup Spreadsheet ID: Link to the snapshot created before building
- Build Time: How long the build took to complete
- Execution Logs: Detailed logs of the build process
Publishing to an Environment
Once you have a successful Data Build, you can publish it to an Environment:
- Select the Data Build you want to publish
- Choose the target Environment
- If the environment has forced diff review enabled, review the differences between the current and new build
- Confirm the publication
The system will perform environment-level safety checks before publishing. These checks help prevent accidental deployments and ensure data integrity.
Comparing Data Builds
Before publishing, you can compare two Data Builds to see what has changed:
- Navigate to the Data Builds comparison feature
- Select the two builds you want to compare
- Review the bundle-level comparison report
- Identify additions, modifications, and deletions
This is especially useful when environments have forced diff review enabled, as you'll need to review changes before publishing.
Environment Safety Features
Environments can be configured with various safety features:
- Forced Diff Review: Requires reviewing changes before publishing
- Environment-Level Safety Checks: Additional validation rules
- Basilisk Definition Lock: Ensures only compatible definitions are used
These features help maintain data integrity and prevent accidental deployments, especially in production environments.
Best Practices
- Always review build logs and warnings before publishing
- Use descriptive build IDs and descriptions for easy tracking
- Compare builds before publishing to production environments
- Test builds in development or QA environments first
- Keep backup spreadsheets for reference and rollback purposes
See the Best Practices for more detailed recommendations.
