Skip to content

Every released version and what changed in it. The body of this page is CHANGELOG.md from the repository, included verbatim, so it can never drift from the notes that ship with a release.

Changes that are merged but not yet released are staged in NEXT_CHANGELOG.md. At release time the workflow folds that file into CHANGELOG.md under a dated heading and cuts the GitHub release from the same text (which is why CHANGELOG.md is never edited by hand).

Version changelog

Release v0.6.0 (2026-08-01)

Notable Changes

  • The release workflow now automatically submits an updated winget manifest (LibreDsc.DscDatabricks) to microsoft/winget-pkgs when a stable release tag is published.

Release v0.5.0 (2026-07-29)

Notable Changes

  • Seven new Unity Catalog resources. The module now manages the full UC object hierarchy and its storage plumbing:
  • LibreDsc.Databricks/Schema and LibreDsc.Databricks/Volume — schemas and (managed or external) volumes under a catalog. Create-only fields (storage_root, volume_type, storage_location) are documented in the schema and left untouched on update.
  • LibreDsc.Databricks/StorageCredential and LibreDsc.Databricks/ServiceCredential — Azure credential blocks (azure_managed_identity backed by an access connector, or azure_service_principal; client_secret is write-only). Both ship a custom test that ignores server-computed nested fields, so configurations converge cleanly.
  • LibreDsc.Databricks/ExternalLocation — storage URLs bound to a storage credential; read_only and fallback are always enforced (explicitly sent even when false).
  • LibreDsc.Databricks/Connection — Lakehouse Federation connections. Updates resend the full options map; secret option values come back redacted and report as drift when specified.
  • LibreDsc.Databricks/Grant — declarative per-principal privileges on any securable (securable_type + full_name + principal → privileges). Set converges the principal's direct privilege set via the permissions delta API, test compares privileges order-insensitively, delete revokes everything, and export enumerates grants on metastore-level securables (catalogs, external locations, credentials, connections). Owner and isolation/predictive-optimization settings that the create APIs don't accept are applied by a chained post-create update, so a single dsc config set converges them.

Bug Fixes

  • Repo lookup and export work on newer workspace generations. Some workspace shards report Git folders with a directory object type instead of REPO in the workspace get-status/list APIs, which made Repo get treat existing repos as missing (breaking branch-only set runs with missing required field(s): url, provider) and export return nothing.

Dependency Updates

  • Bumped github.com/databricks/databricks-sdk-go from v0.163.0 to v0.165.0.

Release v0.4.0 (2026-07-29)

Notable Changes

  • Preview changes before applying them. Every resource now supports what-if: add -w to dsc config set and the result shows exactly what would be created or updated — including the predicted afterState and changedProperties — without touching your workspace. The prediction is computed natively by each resource (no API calls that modify anything), so it is more accurate than the DSC engine's synthetic fallback and does not leak _metadata into changedProperties. dsc resource list shows the new setWhatIf capability on all 15 resources. What-if is advertised via a whatIfArg on the set method (requires DSC v3.2 or later), replacing the deprecated dedicated whatIf operation.
  • Log messages can now be translated. Diagnostic output (shown with DSC_TRACE_LEVEL=info or higher) goes through a localization layer. Set DSC_DATABRICKS_LANG (or rely on LC_ALL/LANG) to pick a language; English ships today and new languages only need a translation table, no code changes.
  • Deleting something that is already gone now succeeds. Previously User, AccountUser, Group, ServicePrincipal, ClusterPolicy, Cluster, and SqlWarehouse returned a not-found error, which could fail a configuration run that was already in the desired state.
  • Richer schemas. Read-only fields you get back from the API (cluster state/state_message, SQL warehouse state/num_clusters, workspace setting etag, repo id/head_commit_id, catalog storage_location/catalog_type/metastore_id) are now documented as optional properties in dsc resource schema output, and enum values are listed for SecretAcl.permission, SqlWarehousePermission.permission_level, Catalog.isolation_mode, and Catalog.enable_predictive_optimization — so editors with schema completion can offer the valid values.
  • Heads-up if you script against set/test output: changedProperties and differingProperties no longer include underscore-prefixed properties such as _exist (custom tests still report _exist when the instance is missing). Update any automation that looked for _exist in those arrays.
  • Manifest layout changed for discovery. The build now produces one libredsc.databricks.<name>.dsc.resource.json file per resource instead of the single aggregate LibreDsc.Databricks.dsc.manifests.json. Point DSC_RESOURCE_PATH at the output directory as before; if you copied or parsed the old aggregate file, switch to the per-resource files.
  • Under the hood: all resources were rebuilt on the released dsc-go-rdk v0.1.0 library, replacing the in-house framework and Cobra CLI. Day-to-day usage (get/set/test/delete/export/schema/manifest) is unchanged.
  • For contributors: authoring guidance now lives in CLAUDE.md (the .github/instructions file points there). Test coverage grew with Go unit tests (validation, request builders, SCIM conversions, what-if projections, localization, manifest/schema parity) and Pester WhatIf contexts in every suite via the new Invoke-DscWhatIf helper; SqlWarehousePermission is covered inline in the SqlWarehouse suite.
  • For contributors: Unity Catalog test environment. Groundwork for the upcoming Unity Catalog object resources: tools/Initialize-DatabricksTests.ps1 gains Test-UnityCatalogAvailable (metastore-attachment detection; UC suites skip on workspaces that are not UC-enabled), New-UnityCatalogTestEnvironment / Remove-UnityCatalogTestEnvironment (tear up / tear down a dedicated catalog + schema fixture through the Unity Catalog REST API, with force-delete cascade on teardown), a New-TestSchemaName generator, and an Invoke-DatabricksApi REST helper. Set DATABRICKS_CATALOG_STORAGE_LOCATION when the metastore has no default managed storage; a per-catalog subdirectory is used so storage locations never overlap.

  • For contributors: serverless SQL warehouse fixture. The SqlWarehouse E2E suite now provisions a serverless PRO warehouse — it starts in seconds and consumes no Azure VM quota. The previous classic warehouse launches on a different VM family than the cluster suite's node type and could spend the entire 20-minute wait in Clusters are failing to launch when that family had no capacity or quota in the region.

  • Cluster supports next-generation compute. New optional properties kind (enum CLASSIC_PREVIEW), is_single_node (only valid with kind = CLASSIC_PREVIEW), and azure_availability (enum SPOT_AZURE, ON_DEMAND_AZURE, SPOT_WITH_FALLBACK_AZURE).

Bug Fixes

  • WorkspaceSetting get no longer fails on never-written settings. On a fresh workspace, settings that have never been written (e.g. default_namespace) return 404 from the settings API, which Get treated as a fatal error (exit code 2). Get now reports such a setting at its server-side default — _exist: true with an explicit empty value and no etag — and Set tolerates the missing etag on its pre-read so the first write goes through (updates already send allow_missing). As part of this, value is now always present in Get output (empty string when unset) instead of being omitted.
  • Group display_name is no longer schema-required. The handler always accepted either id or display_name to identify a group, but the schema marked display_name required, so the DSC engine rejected id-only input (e.g. dsc resource get by id) with a Schema: "display_name" is a required property error before the handler ran. display_name is now optional (still always emitted in output and still required when creating a group).
  • Repo lookup by path works again. The Repos list API now serves canonical /Workspace/Repos/... paths, so the SDK's GetByPath (a client-side exact-string match over the full repo list) no longer found repos requested by their legacy /Repos/... path. Get treated existing repos as missing, which made branch-only set runs fail with missing required field(s): url, provider and export report paths that didn't match the requested form. Repo Get now resolves the path server-side (workspace get-status, which accepts both forms) and fetches the repo by id; Get and Export echo the caller's/tree-walk path form so no spurious path diffs appear.
  • Repo export no longer uses the deprecated Repos.ListAll. As of databricks-sdk-go v0.163.0 that method is deprecated because it omits Git-CLI-enabled repos. Export now walks the Workspace API tree, collecting every REPO object and enriching it with Git metadata via the Repos API; subtrees the caller cannot list are skipped rather than failing the export.

Dependency Updates

  • Bumped github.com/databricks/databricks-sdk-go from v0.118.0 to v0.163.0.
  • Bumped github.com/LibreDsc/dsc-go-rdk to v0.2.0, which advertises native what-if through a whatIfArg on set instead of the deprecated dedicated whatIf manifest method (see PowerShell/DSC#1361; requires DSC v3.2+). Resource handlers are unchanged — only manifest generation and the dsc resource list capability name (whatIf → setWhatIf) differ.
  • Added github.com/LibreDsc/dsc-go-rdk v0.1.0 and promoted golang.org/x/text to a direct dependency; removed spf13/cobra and spf13/pflag. Go toolchain bumped to 1.26.
  • E2E test suites migrated to Pester v6 (Invoke-Pester now uses New-PesterConfiguration with an explicit tests/ path; CI installs Pester 6.0.1).

Release v0.3.0 (2026-04-04)

Notable Changes

  • Added structured JSON logging framework for resource operations, providing trace, debug, info, and error output to stderr following the DSC v3 logging protocol.
  • Added SqlWarehousePermission resource for managing permissions on SQL warehouses. Supports granting permissions to users, groups, and service principals with lookup by warehouse ID or name.

Bug Fixes

  • Wrapped SCIM-based test operation assertions in Group.Tests.ps1 and ServicePrincipal.Tests.ps1 with Set-ItResult -Inconclusive to handle inconsistent boolean values returned by the SCIM API.

Release v0.2.0 (2026-03-28)

Bug Fixes

  • Switched release tagging to use a Personal Access Token to ensure downstream release workflows trigger correctly.

Release v0.1.0 (2026-03-28)

Notable Changes

  • Added User resource for managing workspace users with entitlements and roles.
  • Added AccountUser resource for managing account-level users.
  • Added Group resource with support for member and role assignments.
  • Added ServicePrincipal resource for managing service principals and their entitlements.
  • Added SecretScope resource for creating and managing secret scopes.
  • Added Secret resource for storing and updating secrets within scopes.
  • Added SecretAcl resource for controlling secret scope access permissions.
  • Added Cluster resource with support for autoscaling, Spark configuration, and custom tags.
  • Added ClusterPolicy resource for defining and enforcing cluster creation policies.
  • Added SqlWarehouse resource with Photon support and auto-stop configuration.
  • Added Catalog resource for managing Unity Catalog catalogs.
  • Added Repo resource for managing Git folders in the workspace.
  • Added WorkspaceConf resource for managing workspace configuration keys.
  • Added WorkspaceSetting resource for managing workspace-level settings.
  • Implemented get, set, test, delete, and export operations across all resources.
  • Full support for Databricks unified authentication via environment variables.
  • DSC v3 manifest with schema definitions for all 14 resource types.

Dependency Updates

  • Databricks SDK for Go v0.118.0.