Feature Request: allow "custom_template_format" to be specified

Open Beginner friendly
#6,670 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
go
Domain
cli

Research direction

Start by tracing how the alert resource configuration shown in the issue is parsed and how custom_summary and custom_description are handled. Add support for declaring custom_template_format with MARKDOWN, then verify that the example configuration is accepted and preserves the requested format.

Written by the indexing model from the issue text.

Description

DABs
Describe the issue

When creating an alert we can describe both custom_summary and custom_description, but the field "custom_template_format" is defaulted to HTML. I would like to be able to declare this field, in order to create "MARKDOWN" alert notifications like it's possible in the UI.

Configuration
resources:
  alerts:
    testAlert:
      evaluation:
        comparison_operator: "IS_NOT_NULL"
        empty_result_state: "OK"
        source:
          name: Field
        notification:
          notify_on_ok: false
          retrigger_seconds: 1
          subscriptions:
            - destination_id: destinationId
      schedule:
        quartz_cron_schedule: 0 50 8 ? * *
      display_name: "Name"
      custom_summary: "Name"
      custom_description: "Markdown description.\n\n@QUERY_RESULT_TABLE"
      # custom_template_format: "MARKDOWN" This field is not available
      query_text: >
        select * from test;

OS and CLI version

v1.7.0

Dominant language
Go
Stars
396
Forks
233
Avg merge
1d 23h
Merged PRs (30d)
262

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from databricks/cli

All issues in databricks/cli

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.