bundle: add env var to set record_deployment_history in built-in templates - #6220
Merged
Merged
Conversation
Collaborator
Integration test reportCommit: 0b3d04e
8 interesting tests: 4 RECOVERED, 4 SKIP
Top 6 slowest tests (at least 2 minutes):
|
| // it to the bundle being run. | ||
| // | ||
| // Temporary: remove it and its callers in the templates once this is the default. | ||
| const recordDeploymentHistoryEnvVar = "DATABRICKS_BUNDLE_INIT_RECORD_DEPLOYMENT_HISTORY" |
Contributor
There was a problem hiding this comment.
lets call it DATABRICKS_BUNDLE_RECORD_DEPLOYMENT_HISTORY?
Contributor
Author
There was a problem hiding this comment.
DATABRICKS_BUNDLE_RECORD_DEPLOYMENT_HISTORY sounds like a more generic name, which we may use for general enablement? I wanted to keep this specific variable only for templates
Contributor
Author
There was a problem hiding this comment.
Discussed in DM that we keep a separate var for init for now, and further decide if we want to migrate to generic var in the workspace
shreyas-goenka
approved these changes
Aug 11, 2026
|
|
||
| # record_deployment_history is gated off for now, so generated projects only validate with the | ||
| # force-allow escape hatch set. | ||
| Env.DATABRICKS_BUNDLE_FORCE_ALLOW_RECORD_DEPLOYMENT_HISTORY = "true" |
Contributor
There was a problem hiding this comment.
we don't need this if all we are running is bundle init.
…lates Co-authored-by: Isaac
Co-authored-by: Isaac
Co-authored-by: Isaac
Co-authored-by: Isaac
ilyakuz-db
force-pushed
the
init-record-deployment-history
branch
from
August 12, 2026 08:57
bc8f26c to
0b3d04e
Compare
Collaborator
Integration test reportCommit: 831805c
24 interesting tests: 10 flaky, 6 FAIL, 5 RECOVERED, 2 SKIP, 1 KNOWN
Top 50 slowest tests (at least 2 minutes):
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
bundle initnow writesexperimental.record_deployment_history: trueinto the generateddatabricks.ymlwhenDATABRICKS_BUNDLE_INIT_RECORD_DEPLOYMENT_HISTORYis set. It covers every built-in template that generates adatabricks.yml, and is off by default so template output is otherwise unchanged.Why
Lets new projects opt into recording deployment history at creation time instead of editing the config by hand afterwards. The variable is temporary and deliberately scoped to
bundle init: it persists the setting in the generated project rather than toggling it for the bundle being run.Note the setting is still gated off (#6094), so a generated project also needs
DATABRICKS_BUNDLE_FORCE_ALLOW_RECORD_DEPLOYMENT_HISTORYto validate until that gate is lifted. The acceptance test sets both and runsbundle validate, so it will fail if the two ever drift apart.Tests
New acceptance test: all five templates with the variable on, plus the default-off and explicitly-false cases.