feat(jira): make Jira fields configurable to control which ones are updated

Signed-off-by: Holger Waschke <[email protected]>

Author: holger-waschke

config/notifiers.go

@@ -206,10 +206,14 @@ var (
 		NotifierConfig: NotifierConfig{
 			VSendResolved: true,
 		},
-		APIType:     "auto",
-		Summary:     `{{ template "jira.default.summary" . }}`,
-		Description: `{{ template "jira.default.description" . }}`,
-		Priority:    `{{ template "jira.default.priority" . }}`,
+		APIType: "auto",
+		Summary: JiraFieldConfig{
+			Template: `{{ template "jira.default.summary" . }}`,
+		},
+		Description: JiraFieldConfig{
+			Template: `{{ template "jira.default.description" . }}`,
+		},
+		Priority: `{{ template "jira.default.priority" . }}`,
 	}
 
 	DefaultMattermostConfig = MattermostConfig{
@@ -969,19 +973,26 @@ func (c *MSTeamsV2Config) UnmarshalYAML(unmarshal func(any) error) error {
 	return nil
 }
 
+type JiraFieldConfig struct {
+	// Template is the template string used to render the field.
+	Template string `yaml:"template,omitempty" json:"template,omitempty"`
+	// DisableUpdate indicates whether this field should be omitted when updating an existing issue.
+	DisableUpdate bool `yaml:"disable_update,omitempty" json:"disable_update,omitempty"`
+}
+
 type JiraConfig struct {
 	NotifierConfig `yaml:",inline" json:",inline"`
 	HTTPConfig     *commoncfg.HTTPClientConfig `yaml:"http_config,omitempty" json:"http_config,omitempty"`
 
 	APIURL  *URL   `yaml:"api_url,omitempty" json:"api_url,omitempty"`
 	APIType string `yaml:"api_type,omitempty" json:"api_type,omitempty"`
 
-	Project     string   `yaml:"project,omitempty" json:"project,omitempty"`
-	Summary     string   `yaml:"summary,omitempty" json:"summary,omitempty"`
-	Description string   `yaml:"description,omitempty" json:"description,omitempty"`
-	Labels      []string `yaml:"labels,omitempty" json:"labels,omitempty"`
-	Priority    string   `yaml:"priority,omitempty" json:"priority,omitempty"`
-	IssueType   string   `yaml:"issue_type,omitempty" json:"issue_type,omitempty"`
+	Project     string          `yaml:"project,omitempty" json:"project,omitempty"`
+	Summary     JiraFieldConfig `yaml:"summary,omitempty" json:"summary,omitempty"`
+	Description JiraFieldConfig `yaml:"description,omitempty" json:"description,omitempty"`
+	Labels      []string        `yaml:"labels,omitempty" json:"labels,omitempty"`
+	Priority    string          `yaml:"priority,omitempty" json:"priority,omitempty"`
+	IssueType   string          `yaml:"issue_type,omitempty" json:"issue_type,omitempty"`
 
 	ReopenTransition  string         `yaml:"reopen_transition,omitempty" json:"reopen_transition,omitempty"`
 	ResolveTransition string         `yaml:"resolve_transition,omitempty" json:"resolve_transition,omitempty"`
@@ -991,6 +1002,21 @@ type JiraConfig struct {
 	Fields map[string]any `yaml:"fields,omitempty" json:"custom_fields,omitempty"`
 }
 
+// Supports both the legacy string and the new object form.
+func (f *JiraFieldConfig) UnmarshalYAML(unmarshal func(any) error) error {
+	// Try simple string first (backward compatibility).
+	var s string
+	if err := unmarshal(&s); err == nil {
+		f.Template = s
+		// DisableUpdate stays false by default.
+		return nil
+	}
+
+	// Fallback to full object form.
+	type plain JiraFieldConfig
+	return unmarshal((*plain)(f))
+}
+
 func (c *JiraConfig) UnmarshalYAML(unmarshal func(any) error) error {
 	*c = DefaultJiraConfig
 	type plain JiraConfig

docs/configuration.md

@@ -1159,11 +1159,23 @@ The default `jira.default.description` template only works with V2.
 # The project key where issues are created.
 project: <string>
 
-# Issue summary template.
-[ summary: <tmpl_string> | default = '{{ template "jira.default.summary" . }}' ]
-
-# Issue description template.
-[ description: <tmpl_string> | default = '{{ template "jira.default.description" . }}' ]
+# Issue summary configuration.
+[ summary:
+    # Template for the issue summary.
+    [ template: <tmpl_string> | default = '{{ template "jira.default.summary" . }}' ]
+    
+    # If true, the summary will not be updated when updating an existing issue.
+    [ disable_update: <boolean> | default = false ]
+]
+
+# Issue description configuration.
+[ description:
+    # Template for the issue description.
+    [ template: <tmpl_string> | default = '{{ template "jira.default.description" . }}' ]
+    
+    # If true, the description will not be updated when updating an existing issue.
+    [ disable_update: <boolean> | default = false ]
+]
 
 # Labels to be added to the issue.
 labels:

notify/jira/jira.go

@@ -104,14 +104,35 @@ func (n *Notifier) Notify(ctx context.Context, as ...*types.Alert) (bool, error)
 		path = "issue/" + existingIssue.Key
 		method = http.MethodPut
 
-		logger.Debug("updating existing issue", "issue_key", existingIssue.Key)
+		msg := "updating existing issue"
+		var disabled []string
+		if n.conf.Summary.DisableUpdate {
+			disabled = append(disabled, "summary")
+		}
+		if n.conf.Description.DisableUpdate {
+			disabled = append(disabled, "description")
+		}
+		if len(disabled) > 0 {
+			msg += " without " + strings.Join(disabled, " and ")
+		}
+
+		logger.Debug(msg, "issue_key", existingIssue.Key)
 	}
 
 	requestBody, err := n.prepareIssueRequestBody(ctx, logger, key.Hash(), tmplTextFunc)
 	if err != nil {
 		return false, err
 	}
 
+	if method == http.MethodPut && requestBody.Fields != nil {
+		if n.conf.Description.DisableUpdate {
+			requestBody.Fields.Description = nil
+		}
+		if n.conf.Summary.DisableUpdate {
+			requestBody.Fields.Summary = nil
+		}
+	}
+
 	_, shouldRetry, err = n.doAPIRequest(ctx, method, path, requestBody)
 	if err != nil {
 		return shouldRetry, fmt.Errorf("failed to %s request to %q: %w", method, path, err)
@@ -121,10 +142,11 @@ func (n *Notifier) Notify(ctx context.Context, as ...*types.Alert) (bool, error)
 }
 
 func (n *Notifier) prepareIssueRequestBody(_ context.Context, logger *slog.Logger, groupID string, tmplTextFunc template.TemplateFunc) (issue, error) {
-	summary, err := tmplTextFunc(n.conf.Summary)
+	summary, err := tmplTextFunc(n.conf.Summary.Template)
 	if err != nil {
 		return issue{}, fmt.Errorf("summary template: %w", err)
 	}
+
 	project, err := tmplTextFunc(n.conf.Project)
 	if err != nil {
 		return issue{}, fmt.Errorf("project template: %w", err)
@@ -156,12 +178,12 @@ func (n *Notifier) prepareIssueRequestBody(_ context.Context, logger *slog.Logge
 	requestBody := issue{Fields: &issueFields{
 		Project:   &issueProject{Key: project},
 		Issuetype: &idNameValue{Name: issueType},
-		Summary:   summary,
+		Summary:   &summary,
 		Labels:    make([]string, 0, len(n.conf.Labels)+1),
 		Fields:    fieldsWithStringKeys,
 	}}
 
-	issueDescriptionString, err := tmplTextFunc(n.conf.Description)
+	issueDescriptionString, err := tmplTextFunc(n.conf.Description.Template)
 	if err != nil {
 		return issue{}, fmt.Errorf("description template: %w", err)
 	}
@@ -171,14 +193,13 @@ func (n *Notifier) prepareIssueRequestBody(_ context.Context, logger *slog.Logge
 		logger.Warn("Truncated description", "max_runes", maxDescriptionLenRunes)
 	}
 
-	requestBody.Fields.Description = issueDescriptionString
-	if strings.HasSuffix(n.conf.APIURL.Path, "/3") {
-		var issueDescription any
-		if err := json.Unmarshal([]byte(issueDescriptionString), &issueDescription); err != nil {
-			return issue{}, fmt.Errorf("description unmarshaling: %w", err)
+	descriptionCopy := issueDescriptionString
+	if isAPIv3Path(n.conf.APIURL.Path) {
+		if !json.Valid([]byte(descriptionCopy)) {
+			return issue{}, fmt.Errorf("description template: invalid JSON for API v3")
 		}
-		requestBody.Fields.Description = issueDescription
 	}
+	requestBody.Fields.Description = &descriptionCopy
 
 	for i, label := range n.conf.Labels {
 		label, err = tmplTextFunc(label)
@@ -395,3 +416,7 @@ func (n *Notifier) doAPIRequestFullPath(ctx context.Context, method, path string
 
 	return responseBody, false, nil
 }
+
+func isAPIv3Path(path string) bool {
+	return strings.HasSuffix(strings.TrimRight(path, "/"), "/3")
+}