databricks / cli

Databricks CLI
Other
148 stars 56 forks source link

Include example usage in release notes #1730

Closed stevenayers-bge closed 1 month ago

stevenayers-bge commented 2 months ago

Describe the issue

The new releases for DABs often include some great new features (such as complex variables). It would be great to see some example usage included with release notes or a link to the updated section in the Databricks documentation.

The same goes for any bug fixes. It would be great to see an example of the changed behaviour. If a bug has been reported by a user, this information is often included in the issue, but if raised internally by the team developing DABs, that information is sometimes missing.

andrewnester commented 2 months ago

Thanks for the request! We try to keep knoweledge base to show case DABs features here https://github.com/databricks/bundle-examples/tree/main/knowledge_base

But it's indeed lagging a bit comparing to releases we make, we'll try to add more examples as we go but we are open for contributions as well.

As to examples of bug fixes, could you elaborate a bit what would you like to see improved? In release notes we link changes to PRs and for anything that significant enough PRs usually contains details of what was changed.

andrewnester commented 1 month ago

We recently introduced a new doc page where we'll be posting DABs release notes with a bit more details describing all significant changes

https://docs.databricks.com/en/release-notes/dev-tools/bundles.html