databricks-cli/cmd
Lennart Kats (databricks) 433f401c83
Add validation for Git settings in bundles (#578)
## Changes

This checks whether the Git settings are consistent with the actual Git
state of a source directory.

(This PR adds to https://github.com/databricks/cli/pull/577.) 

Previously, we would silently let users configure their Git branch to
e.g. `main` and deploy with that metadata even if they were actually on
a different branch.

With these changes, the following config would result in an error when
deployed from any other branch than `main`:

```
bundle:
  name: example

workspace:
  git:
    branch: main

environments:
  ...
```

> not on the right Git branch:
>   expected according to configuration: main
>   actual: my-feature-branch

It's not very useful to set the same branch for all environments,
though. For development, it's better to just let the CLI auto-detect the
right branch. Therefore, it's now possible to set the branch just for a
single environment:

```
bundle:
  name: example 2

environments:
  development:
    default: true

  production:
    # production can only be deployed from the 'main' branch
    git:
      branch: main
```

Adding to that, the `mode: production` option actually checks that users
explicitly set the Git branch as seen above. Setting that branch helps
avoid mistakes, where someone accidentally deploys to production from
the wrong branch. (I could see us offering an escape hatch for that in
the future.)

# Testing

Manual testing to validate the experience and error messages. Automated
unit tests.

---------

Co-authored-by: Fabian Jakobs <fabian.jakobs@databricks.com>
2023-07-30 12:44:33 +00:00
..
account Release v0.202.0 (#619) 2023-07-27 13:23:55 +00:00
api Remove dependency on global state for remaining commands (#613) 2023-07-27 10:03:08 +00:00
auth Remove dependency on global state for remaining commands (#613) 2023-07-27 10:03:08 +00:00
bundle Add validation for Git settings in bundles (#578) 2023-07-30 12:44:33 +00:00
configure Remove dependency on global state for remaining commands (#613) 2023-07-27 10:03:08 +00:00
fs Remove dependency on global state for remaining commands (#613) 2023-07-27 10:03:08 +00:00
root Remove dependency on global state for remaining commands (#613) 2023-07-27 10:03:08 +00:00
sync Remove dependency on global state for remaining commands (#613) 2023-07-27 10:03:08 +00:00
version Remove dependency on global state for remaining commands (#613) 2023-07-27 10:03:08 +00:00
workspace Release v0.202.0 (#619) 2023-07-27 13:23:55 +00:00
cmd.go Remove dependency on global state for remaining commands (#613) 2023-07-27 10:03:08 +00:00