databricks-cli/libs/template/templates/default-sql/template/{{.project_name}}
shreyas-goenka a4ba0bbe9f
Add sub-extension to resource files in built-in templates (#1777)
## Changes
We want to encourage a pattern of only specifying a single resource in a
YAML file when an `.<resource-type>.yml` (like `.job.yml`) is used. This
convention could allow us to bijectively map a resource YAML file to
it's corresponding resource in the Databricks workspace.

This PR simply makes the built-in templates compliant to this format.

## Tests
Existing tests.
2024-09-25 12:58:14 +00:00
..
.vscode Add an experimental default-sql template (#1051) 2024-02-19 12:01:11 +00:00
resources Add sub-extension to resource files in built-in templates (#1777) 2024-09-25 12:58:14 +00:00
scratch Add an experimental default-sql template (#1051) 2024-02-19 12:01:11 +00:00
src Add sub-extension to resource files in built-in templates (#1777) 2024-09-25 12:58:14 +00:00
README.md.tmpl Add an experimental default-sql template (#1051) 2024-02-19 12:01:11 +00:00
databricks.yml.tmpl Include a permissions section in all templates (#1713) 2024-09-03 07:51:54 +00:00

README.md.tmpl

# {{.project_name}}

The '{{.project_name}}' project was generated by using the default-sql template.

## Getting started

1. Install the Databricks CLI from https://docs.databricks.com/dev-tools/cli/install.html

2. Authenticate to your Databricks workspace (if you have not done so already):
    ```
    $ databricks configure
    ```

3. To deploy a development copy of this project, type:
    ```
    $ databricks bundle deploy --target dev
    ```
    (Note that "dev" is the default target, so the `--target` parameter
    is optional here.)

    This deploys everything that's defined for this project.
    For example, the default template would deploy a job called
    `[dev yourname] {{.project_name}}_job` to your workspace.
    You can find that job by opening your workpace and clicking on **Workflows**.

4. Similarly, to deploy a production copy, type:
   ```
   $ databricks bundle deploy --target prod
   ```

5. To run a job, use the "run" command:
   ```
   $ databricks bundle run
   ```

6. Optionally, install developer tools such as the Databricks extension for Visual Studio Code from
   https://docs.databricks.com/dev-tools/vscode-ext.html.

7. For documentation on the Databricks Asset Bundles format used
   for this project, and for CI/CD configuration, see
   https://docs.databricks.com/dev-tools/bundles/index.html.