From b74923b4147939c05e13b868ef57f05510df726b Mon Sep 17 00:00:00 2001 From: "m.huber" Date: Mon, 19 Feb 2024 23:03:13 +0100 Subject: [PATCH 01/32] format tables --- .../issue-pull-request-templates.en-us.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/content/usage/issue-pull-request-templates.en-us.md b/docs/content/usage/issue-pull-request-templates.en-us.md index 34475e346588..9bd3c17bb00b 100644 --- a/docs/content/usage/issue-pull-request-templates.en-us.md +++ b/docs/content/usage/issue-pull-request-templates.en-us.md @@ -291,15 +291,15 @@ contact_links: ### Possible Options -| Key | Description | Type | Default | -|----------------------|-------------------------------------------------------------------------------------------------------|--------------------|----------------| -| blank_issues_enabled | If set to false, the User is forced to use a Template | Boolean | true | -| contact_links | Custom Links to show in the Choose Box | Contact Link Array | Empty Array | +| Key | Description | Type | Default | +|----------------------|-------------------------------------------------------|--------------------|-------------| +| blank_issues_enabled | If set to false, the User is forced to use a Template | Boolean | true | +| contact_links | Custom Links to show in the Choose Box | Contact Link Array | Empty Array | ### Contact Link -| Key | Description | Type | Required | -|----------------------|-------------------------------------------------------------------------------------------------------|---------|----------| -| name | the name of your link | String | true | -| url | The URL of your Link | String | true | -| about | A short description of your Link | String | true | +| Key | Description | Type | Required | +|-------|----------------------------------|--------|----------| +| name | the name of your link | String | true | +| url | The URL of your Link | String | true | +| about | A short description of your Link | String | true | From f451c378f8e092fbfe54874a71fbb4b32a0db6e7 Mon Sep 17 00:00:00 2001 From: "m.huber" Date: Mon, 19 Feb 2024 23:14:19 +0100 Subject: [PATCH 02/32] document feature first :D --- .../issue-pull-request-templates.en-us.md | 24 ++++++++++++------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/docs/content/usage/issue-pull-request-templates.en-us.md b/docs/content/usage/issue-pull-request-templates.en-us.md index 9bd3c17bb00b..411fa067361b 100644 --- a/docs/content/usage/issue-pull-request-templates.en-us.md +++ b/docs/content/usage/issue-pull-request-templates.en-us.md @@ -190,13 +190,15 @@ body: ### Markdown -You can use a `markdown` element to display Markdown in your form that provides extra context to the user, but is not submitted. +You can use a `markdown` element to display Markdown in your form that provides extra context to the user, but is not submitted by default. Attributes: -| Key | Description | Required | Type | Default | Valid values | -|-------|--------------------------------------------------------------|----------|--------|---------|--------------| -| value | The text that is rendered. Markdown formatting is supported. | Required | String | - | - | +| Key | Description | Required | Type | Default | Valid values | +|--------|--------------------------------------------------------------|----------|---------|---------|--------------| +| value | The text that is rendered. Markdown formatting is supported. | Required | String | - | - | +| submit | The text that is rendered, will be submitted. | Optional | Boolean | false | - | +| hide | Do not render in the from. | Optional | Boolean | false | - | ### Textarea @@ -264,11 +266,13 @@ You can use the `checkboxes` element to add a set of checkboxes to your form. Attributes: -| Key | Description | Required | Type | Default | Valid values | -|-------------|-------------------------------------------------------------------------------------------------------|----------|--------|--------------|--------------| -| label | A brief description of the expected user input, which is displayed in the form. | Required | String | - | - | -| description | A description of the set of checkboxes, which is displayed in the form. Supports Markdown formatting. | Optional | String | Empty String | - | -| options | An array of checkboxes that the user can select. For syntax, see below. | Required | Array | - | - | +| Key | Description | Required | Type | Default | Valid values | +|-------------|-------------------------------------------------------------------------------------------------------|----------|---------|--------------|--------------| +| label | A brief description of the expected user input, which is displayed in the form. | Required | String | - | - | +| description | A description of the set of checkboxes, which is displayed in the form. Supports Markdown formatting. | Optional | String | Empty String | - | +| options | An array of checkboxes that the user can select. For syntax, see below. | Required | Array | - | - | +| submit | The checkboxes are rendered, will be submitted. | Optional | Boolean | true | - | +| hide | Do not render in the from. | Optional | Boolean | false | - | For each value in the options array, you can set the following keys. @@ -276,6 +280,8 @@ For each value in the options array, you can set the following keys. |----------|------------------------------------------------------------------------------------------------------------------------------------------|----------|---------|---------|---------| | label | The identifier for the option, which is displayed in the form. Markdown is supported for bold or italic text formatting, and hyperlinks. | Required | String | - | - | | required | Prevents form submission until element is completed. | Optional | Boolean | false | - | +| submit | The specific checkbox that is rendered, will be submitted. | Optional | Boolean | true | - | +| hide | Do not render in the from. | Optional | Boolean | false | - | ## Syntax for issue config From a5e7a03850e2002ef0f6d70cc430fd60aab8f130 Mon Sep 17 00:00:00 2001 From: "m.huber" Date: Tue, 20 Feb 2024 00:09:24 +0100 Subject: [PATCH 03/32] fix docu and add support in validation --- .../issue-pull-request-templates.en-us.md | 35 ++++++++++++------- modules/issue/template/template.go | 12 +++++++ modules/issue/template/unmarshal.go | 15 ++++++++ modules/structs/issue.go | 2 ++ 4 files changed, 52 insertions(+), 12 deletions(-) diff --git a/docs/content/usage/issue-pull-request-templates.en-us.md b/docs/content/usage/issue-pull-request-templates.en-us.md index 411fa067361b..168e13ce8c1a 100644 --- a/docs/content/usage/issue-pull-request-templates.en-us.md +++ b/docs/content/usage/issue-pull-request-templates.en-us.md @@ -194,11 +194,12 @@ You can use a `markdown` element to display Markdown in your form that provides Attributes: -| Key | Description | Required | Type | Default | Valid values | -|--------|--------------------------------------------------------------|----------|---------|---------|--------------| -| value | The text that is rendered. Markdown formatting is supported. | Required | String | - | - | -| submit | The text that is rendered, will be submitted. | Optional | Boolean | false | - | -| hide | Do not render in the from. | Optional | Boolean | false | - | +| Key | Description | Required | Type | Default | Valid values | +|-------|--------------------------------------------------------------|----------|--------|---------|--------------| +| value | The text that is rendered. Markdown formatting is supported. | Required | String | - | - | + +Submit: Default is **false** +Hide: Default is **false** ### Textarea @@ -220,6 +221,9 @@ Validations: |----------|------------------------------------------------------|----------|---------|---------|--------------| | required | Prevents form submission until element is completed. | Optional | Boolean | false | - | +Submit: Default is **true** +Hide: Default is **false** + ### Input You can use an `input` element to add a single-line text field to your form. @@ -241,6 +245,9 @@ Validations: | is_number | Prevents form submission until element is filled with a number. | Optional | Boolean | false | - | | regex | Prevents form submission until element is filled with a value that match the regular expression. | Optional | String | - | a [regular expression](https://en.wikipedia.org/wiki/Regular_expression) | +Submit: Default is **true** +Hide: Default is **false** + ### Dropdown You can use a `dropdown` element to add a dropdown menu in your form. @@ -260,19 +267,20 @@ Validations: |----------|------------------------------------------------------|----------|---------|---------|--------------| | required | Prevents form submission until element is completed. | Optional | Boolean | false | - | +Submit: Default is **true** +Hide: Default is **false** + ### Checkboxes You can use the `checkboxes` element to add a set of checkboxes to your form. Attributes: -| Key | Description | Required | Type | Default | Valid values | -|-------------|-------------------------------------------------------------------------------------------------------|----------|---------|--------------|--------------| -| label | A brief description of the expected user input, which is displayed in the form. | Required | String | - | - | -| description | A description of the set of checkboxes, which is displayed in the form. Supports Markdown formatting. | Optional | String | Empty String | - | -| options | An array of checkboxes that the user can select. For syntax, see below. | Required | Array | - | - | -| submit | The checkboxes are rendered, will be submitted. | Optional | Boolean | true | - | -| hide | Do not render in the from. | Optional | Boolean | false | - | +| Key | Description | Required | Type | Default | Valid values | +|-------------|-------------------------------------------------------------------------------------------------------|----------|--------|--------------|--------------| +| label | A brief description of the expected user input, which is displayed in the form. | Required | String | - | - | +| description | A description of the set of checkboxes, which is displayed in the form. Supports Markdown formatting. | Optional | String | Empty String | - | +| options | An array of checkboxes that the user can select. For syntax, see below. | Required | Array | - | - | For each value in the options array, you can set the following keys. @@ -283,6 +291,9 @@ For each value in the options array, you can set the following keys. | submit | The specific checkbox that is rendered, will be submitted. | Optional | Boolean | true | - | | hide | Do not render in the from. | Optional | Boolean | false | - | +Submit: Default is **true** +Hide: Default is **false** + ## Syntax for issue config This is a example for a issue config file diff --git a/modules/issue/template/template.go b/modules/issue/template/template.go index 4e813fc91f78..85b6b01658bc 100644 --- a/modules/issue/template/template.go +++ b/modules/issue/template/template.go @@ -177,6 +177,18 @@ func validateOptions(field *api.IssueFormField, idx int) error { return position.Errorf("'required' should be a bool") } } + + if submit, ok := opt["submit"]; ok { + if _, ok := submit.(bool); !ok { + return position.Errorf("'submit' should be a bool") + } + } + + if hide, ok := opt["hide"]; ok { + if _, ok := hide.(bool); !ok { + return position.Errorf("'required' should be a bool") + } + } } } return nil diff --git a/modules/issue/template/unmarshal.go b/modules/issue/template/unmarshal.go index 8cae8d4c4299..44b2b553dfa1 100644 --- a/modules/issue/template/unmarshal.go +++ b/modules/issue/template/unmarshal.go @@ -128,9 +128,24 @@ func unmarshal(filename string, content []byte) (*api.IssueTemplate, error) { } } for i, v := range it.Fields { + // set default id value if v.ID == "" { v.ID = strconv.Itoa(i) } + // set default submit value + if v.Submit == nil { + submit := true + // markdown is not submitted by default + if v.Type == api.IssueFormFieldTypeMarkdown { + submit = false + } + v.Submit = &submit + } + // set default hide value + if v.Hide == nil { + hide := false + v.Hide = &hide + } } } diff --git a/modules/structs/issue.go b/modules/structs/issue.go index 34eae693299a..06c92f0198b5 100644 --- a/modules/structs/issue.go +++ b/modules/structs/issue.go @@ -145,6 +145,8 @@ type IssueFormField struct { ID string `json:"id" yaml:"id"` Attributes map[string]any `json:"attributes" yaml:"attributes"` Validations map[string]any `json:"validations" yaml:"validations"` + Submit *bool `json:"submit,omitempty" yaml:"submit,omitempty"` + Hide *bool `json:"hide,omitempty" yaml:"hide,omitempty"` } // IssueTemplate represents an issue template for a repository From 7913baede6baf99a9072d8722eb0299a7f39b2d3 Mon Sep 17 00:00:00 2001 From: "m.huber" Date: Tue, 20 Feb 2024 02:23:57 +0100 Subject: [PATCH 04/32] make checkbox able to hide and to not be subbmitted --- modules/issue/template/template.go | 26 +++++++++++++++++++-- templates/repo/issue/fields/checkboxes.tmpl | 2 +- 2 files changed, 25 insertions(+), 3 deletions(-) diff --git a/modules/issue/template/template.go b/modules/issue/template/template.go index 85b6b01658bc..b0cd02c9564d 100644 --- a/modules/issue/template/template.go +++ b/modules/issue/template/template.go @@ -265,8 +265,16 @@ type valuedField struct { } func (f *valuedField) WriteTo(builder *strings.Builder) { - if f.Type == api.IssueFormFieldTypeMarkdown { - // markdown blocks do not appear in output + // make sure submit is not nil + if f.Submit == nil { + submit := true + // markdown blocks do not appear in output by default + if f.Type == api.IssueFormFieldTypeMarkdown { + submit = false + } + f.Submit = &submit + } + if !*f.Submit { return } @@ -281,6 +289,9 @@ func (f *valuedField) WriteTo(builder *strings.Builder) { switch f.Type { case api.IssueFormFieldTypeCheckboxes: for _, option := range f.Options() { + if !option.Submit() { + continue + } checked := " " if option.IsChecked() { checked = "x" @@ -397,6 +408,17 @@ func (o *valuedOption) IsChecked() bool { return false } +func (o *valuedOption) Submit() bool { + if o.field.Type == api.IssueFormFieldTypeCheckboxes { + if vs, ok := o.data.(map[string]any); ok { + if v, ok := vs["submit"].(bool); ok { + return v + } + } + } + return true +} + var minQuotesRegex = regexp.MustCompilePOSIX("^`{3,}") // minQuotes return 3 or more back-quotes. diff --git a/templates/repo/issue/fields/checkboxes.tmpl b/templates/repo/issue/fields/checkboxes.tmpl index 237f2eb5dd93..c0bcc7b9308b 100644 --- a/templates/repo/issue/fields/checkboxes.tmpl +++ b/templates/repo/issue/fields/checkboxes.tmpl @@ -2,7 +2,7 @@ {{template "repo/issue/fields/header" .}} {{range $i, $opt := .item.Attributes.options}}
-
+
From e01a7c0dba594aab9d10f9dd5b38d9afa0e0a947 Mon Sep 17 00:00:00 2001 From: "m.huber" Date: Tue, 20 Feb 2024 02:44:19 +0100 Subject: [PATCH 05/32] make optional markdown submit work --- modules/issue/template/template.go | 31 ++++++++++++++++-------------- 1 file changed, 17 insertions(+), 14 deletions(-) diff --git a/modules/issue/template/template.go b/modules/issue/template/template.go index b0cd02c9564d..82edcc6f4f79 100644 --- a/modules/issue/template/template.go +++ b/modules/issue/template/template.go @@ -250,7 +250,7 @@ func RenderToMarkdown(template *api.IssueTemplate, values url.Values) string { IssueFormField: field, Values: values, } - if f.ID == "" { + if f.ID == "" || f.NoSubmit() { continue } f.WriteTo(builder) @@ -265,19 +265,6 @@ type valuedField struct { } func (f *valuedField) WriteTo(builder *strings.Builder) { - // make sure submit is not nil - if f.Submit == nil { - submit := true - // markdown blocks do not appear in output by default - if f.Type == api.IssueFormFieldTypeMarkdown { - submit = false - } - f.Submit = &submit - } - if !*f.Submit { - return - } - // write label if !f.HideLabel() { _, _ = fmt.Fprintf(builder, "### %s\n\n", f.Label()) @@ -325,6 +312,10 @@ func (f *valuedField) WriteTo(builder *strings.Builder) { } else { _, _ = fmt.Fprintf(builder, "%s\n", value) } + case api.IssueFormFieldTypeMarkdown: + if v, ok := f.Attributes["value"].(string); ok { + _, _ = fmt.Fprint(builder, v) + } } _, _ = fmt.Fprintln(builder) } @@ -336,7 +327,19 @@ func (f *valuedField) Label() string { return "" } +func (f *valuedField) NoSubmit() bool { + // handle default case + if f.Submit == nil { + // markdown blocks do not appear in output by default + return f.Type == api.IssueFormFieldTypeMarkdown + } + return !*f.Submit +} + func (f *valuedField) HideLabel() bool { + if f.Type == api.IssueFormFieldTypeMarkdown { + return true + } if label, ok := f.Attributes["hide_label"].(bool); ok { return label } From f73b4449b6060b1d604a54652b6501071b964757 Mon Sep 17 00:00:00 2001 From: "m.huber" Date: Tue, 20 Feb 2024 03:07:42 +0100 Subject: [PATCH 06/32] make hide option work --- modules/templates/helper.go | 9 +++++++++ templates/repo/issue/fields/checkboxes.tmpl | 2 +- templates/repo/issue/fields/dropdown.tmpl | 2 +- templates/repo/issue/fields/input.tmpl | 2 +- templates/repo/issue/fields/markdown.tmpl | 2 +- templates/repo/issue/fields/textarea.tmpl | 2 +- 6 files changed, 14 insertions(+), 5 deletions(-) diff --git a/modules/templates/helper.go b/modules/templates/helper.go index 6e42594b0b7d..cab164582941 100644 --- a/modules/templates/helper.go +++ b/modules/templates/helper.go @@ -176,9 +176,18 @@ func NewFuncMap() template.FuncMap { "FilenameIsImage": FilenameIsImage, "TabSizeClass": TabSizeClass, + "BoolPtrVal": PtrVal[bool], } } +// PtrVal return the value of an pointer or init a new empty one based on pointer type +func PtrVal[T any](ptr *T) T { + if ptr == nil { + ptr = new(T) + } + return *ptr +} + // Safe render raw as HTML func Safe(s any) template.HTML { switch v := s.(type) { diff --git a/templates/repo/issue/fields/checkboxes.tmpl b/templates/repo/issue/fields/checkboxes.tmpl index c0bcc7b9308b..015fac6cc42a 100644 --- a/templates/repo/issue/fields/checkboxes.tmpl +++ b/templates/repo/issue/fields/checkboxes.tmpl @@ -1,4 +1,4 @@ -
+
{{template "repo/issue/fields/header" .}} {{range $i, $opt := .item.Attributes.options}}
diff --git a/templates/repo/issue/fields/dropdown.tmpl b/templates/repo/issue/fields/dropdown.tmpl index 23aa373cd209..914da5d75488 100644 --- a/templates/repo/issue/fields/dropdown.tmpl +++ b/templates/repo/issue/fields/dropdown.tmpl @@ -1,4 +1,4 @@ -
+
{{template "repo/issue/fields/header" .}} {{/* FIXME: required validation */}}
diff --git a/templates/repo/issue/fields/input.tmpl b/templates/repo/issue/fields/input.tmpl index 3fc8a8651048..b514bcb66ca8 100644 --- a/templates/repo/issue/fields/input.tmpl +++ b/templates/repo/issue/fields/input.tmpl @@ -1,4 +1,4 @@ -
+
{{template "repo/issue/fields/header" .}}
diff --git a/templates/repo/issue/fields/markdown.tmpl b/templates/repo/issue/fields/markdown.tmpl index fd5b6afd227f..d0763c7e20dc 100644 --- a/templates/repo/issue/fields/markdown.tmpl +++ b/templates/repo/issue/fields/markdown.tmpl @@ -1,3 +1,3 @@ -
+
{{RenderMarkdownToHtml .Context .item.Attributes.value}}
diff --git a/templates/repo/issue/fields/textarea.tmpl b/templates/repo/issue/fields/textarea.tmpl index 55adeb28d08f..749d97888132 100644 --- a/templates/repo/issue/fields/textarea.tmpl +++ b/templates/repo/issue/fields/textarea.tmpl @@ -1,5 +1,5 @@ {{$useMarkdownEditor := not .item.Attributes.render}} -
+
{{template "repo/issue/fields/header" .}} {{/* the real form element to provide the value */}} From 91662c195cc748143a086794b46313ae1fbff4af Mon Sep 17 00:00:00 2001 From: "m.huber" Date: Tue, 20 Feb 2024 03:12:56 +0100 Subject: [PATCH 07/32] extend example --- .../usage/issue-pull-request-templates.en-us.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/content/usage/issue-pull-request-templates.en-us.md b/docs/content/usage/issue-pull-request-templates.en-us.md index 168e13ce8c1a..283fa9ff1679 100644 --- a/docs/content/usage/issue-pull-request-templates.en-us.md +++ b/docs/content/usage/issue-pull-request-templates.en-us.md @@ -135,6 +135,13 @@ body: attributes: value: | Thanks for taking the time to fill out this bug report! +# some markdown witch will be visible only in the created issue + - type: markdown + attributes: + value: | + This issue git created by an issue **template** :) + hide: true + submit: true - type: input id: contact attributes: @@ -186,6 +193,11 @@ body: options: - label: I agree to follow this project's Code of Conduct required: true + - label: I also have read the CONTRIBUTION.MD + required: true + submit: false + - label: This is a TODO only visible after issue creation + hide: true ``` ### Markdown From a788fb7872780b6761eb25f6e3577ea342cd06dc Mon Sep 17 00:00:00 2001 From: 6543 <6543@obermui.de> Date: Tue, 20 Feb 2024 03:21:43 +0100 Subject: [PATCH 08/32] Update modules/issue/template/template.go --- modules/issue/template/template.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/issue/template/template.go b/modules/issue/template/template.go index 82edcc6f4f79..8faefa355f4e 100644 --- a/modules/issue/template/template.go +++ b/modules/issue/template/template.go @@ -186,7 +186,7 @@ func validateOptions(field *api.IssueFormField, idx int) error { if hide, ok := opt["hide"]; ok { if _, ok := hide.(bool); !ok { - return position.Errorf("'required' should be a bool") + return position.Errorf("'hide' should be a bool") } } } From e029f7d4ac3d2ab291a46bd2e441d90da5231849 Mon Sep 17 00:00:00 2001 From: 6543 <6543@obermui.de> Date: Tue, 20 Feb 2024 03:23:56 +0100 Subject: [PATCH 09/32] Update templates/repo/issue/fields/checkboxes.tmpl --- templates/repo/issue/fields/checkboxes.tmpl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/repo/issue/fields/checkboxes.tmpl b/templates/repo/issue/fields/checkboxes.tmpl index 015fac6cc42a..1261a262e558 100644 --- a/templates/repo/issue/fields/checkboxes.tmpl +++ b/templates/repo/issue/fields/checkboxes.tmpl @@ -2,7 +2,7 @@ {{template "repo/issue/fields/header" .}} {{range $i, $opt := .item.Attributes.options}}
-
+
From 22d61545306b3710f318e2daf5dc37330e1056fd Mon Sep 17 00:00:00 2001 From: 6543 <6543@obermui.de> Date: Tue, 20 Feb 2024 03:25:49 +0100 Subject: [PATCH 10/32] Update modules/issue/template/unmarshal.go --- modules/issue/template/unmarshal.go | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/modules/issue/template/unmarshal.go b/modules/issue/template/unmarshal.go index 44b2b553dfa1..3154d9b6d65a 100644 --- a/modules/issue/template/unmarshal.go +++ b/modules/issue/template/unmarshal.go @@ -143,8 +143,7 @@ func unmarshal(filename string, content []byte) (*api.IssueTemplate, error) { } // set default hide value if v.Hide == nil { - hide := false - v.Hide = &hide + v.Hide = new(bool) // set false } } } From 0a276106947c617c294791c53f5026680eebbd1d Mon Sep 17 00:00:00 2001 From: "m.huber" Date: Tue, 20 Feb 2024 03:31:18 +0100 Subject: [PATCH 11/32] docs add newline --- docs/content/usage/issue-pull-request-templates.en-us.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/content/usage/issue-pull-request-templates.en-us.md b/docs/content/usage/issue-pull-request-templates.en-us.md index 283fa9ff1679..80b9d9108afa 100644 --- a/docs/content/usage/issue-pull-request-templates.en-us.md +++ b/docs/content/usage/issue-pull-request-templates.en-us.md @@ -211,6 +211,7 @@ Attributes: | value | The text that is rendered. Markdown formatting is supported. | Required | String | - | - | Submit: Default is **false** + Hide: Default is **false** ### Textarea @@ -234,6 +235,7 @@ Validations: | required | Prevents form submission until element is completed. | Optional | Boolean | false | - | Submit: Default is **true** + Hide: Default is **false** ### Input @@ -258,6 +260,7 @@ Validations: | regex | Prevents form submission until element is filled with a value that match the regular expression. | Optional | String | - | a [regular expression](https://en.wikipedia.org/wiki/Regular_expression) | Submit: Default is **true** + Hide: Default is **false** ### Dropdown @@ -280,6 +283,7 @@ Validations: | required | Prevents form submission until element is completed. | Optional | Boolean | false | - | Submit: Default is **true** + Hide: Default is **false** ### Checkboxes @@ -304,6 +308,7 @@ For each value in the options array, you can set the following keys. | hide | Do not render in the from. | Optional | Boolean | false | - | Submit: Default is **true** + Hide: Default is **false** ## Syntax for issue config From f03b52739d623f1058985769884b9ed2dbb91a9f Mon Sep 17 00:00:00 2001 From: 6543 <6543@obermui.de> Date: Tue, 20 Feb 2024 08:34:32 +0100 Subject: [PATCH 12/32] update swagger --- templates/swagger/v1_json.tmpl | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl index d26bed53aaee..f3a57c93ad45 100644 --- a/templates/swagger/v1_json.tmpl +++ b/templates/swagger/v1_json.tmpl @@ -20377,10 +20377,18 @@ "additionalProperties": {}, "x-go-name": "Attributes" }, + "hide": { + "type": "boolean", + "x-go-name": "Hide" + }, "id": { "type": "string", "x-go-name": "ID" }, + "submit": { + "type": "boolean", + "x-go-name": "Submit" + }, "type": { "$ref": "#/definitions/IssueFormFieldType" }, From 45c9a3916b780ab89a4ed54bf6b82685d49542f2 Mon Sep 17 00:00:00 2001 From: 6543 <6543@obermui.de> Date: Tue, 20 Feb 2024 09:19:47 +0100 Subject: [PATCH 13/32] extend tests --- modules/issue/template/template_test.go | 78 ++++++++++++++++++++----- 1 file changed, 63 insertions(+), 15 deletions(-) diff --git a/modules/issue/template/template_test.go b/modules/issue/template/template_test.go index 06e6b70d35f6..d4a4e62bbeea 100644 --- a/modules/issue/template/template_test.go +++ b/modules/issue/template/template_test.go @@ -14,6 +14,8 @@ import ( ) func TestValidate(t *testing.T) { + fBool := false + tBool := true tests := []struct { name string filename string @@ -374,8 +376,11 @@ body: required: true - label: Option 2 of checkboxes required: false - - label: Option 3 of checkboxes + - label: Hidden Option 3 of checkboxes + hide: true + - label: Required but not submitted required: true + submit: false `, want: &api.IssueTemplate{ Name: "Name", @@ -390,6 +395,8 @@ body: Attributes: map[string]any{ "value": "Value of the markdown", }, + Submit: &fBool, + Hide: &fBool, }, { Type: "textarea", @@ -404,6 +411,8 @@ body: Validations: map[string]any{ "required": true, }, + Submit: &tBool, + Hide: &fBool, }, { Type: "input", @@ -419,6 +428,8 @@ body: "is_number": true, "regex": "[a-zA-Z0-9]+", }, + Submit: &tBool, + Hide: &fBool, }, { Type: "dropdown", @@ -436,6 +447,8 @@ body: Validations: map[string]any{ "required": true, }, + Submit: &tBool, + Hide: &fBool, }, { Type: "checkboxes", @@ -446,9 +459,12 @@ body: "options": []any{ map[string]any{"label": "Option 1 of checkboxes", "required": true}, map[string]any{"label": "Option 2 of checkboxes", "required": false}, - map[string]any{"label": "Option 3 of checkboxes", "required": true}, + map[string]any{"label": "Option 3 of checkboxes", "required": false, "hide": true}, + map[string]any{"label": "Required but not submitted", "required": false, "submit": false}, }, }, + Submit: &tBool, + Hide: &fBool, }, }, FileName: "test.yaml", @@ -467,7 +483,13 @@ body: - type: markdown id: id1 attributes: - value: Value of the markdown + value: Value of the markdown shown in form + - type: markdown + id: id2 + attributes: + value: Value of the markdown shown in created issue + hide: true + submit: true `, want: &api.IssueTemplate{ Name: "Name", @@ -480,8 +502,19 @@ body: Type: "markdown", ID: "id1", Attributes: map[string]any{ - "value": "Value of the markdown", + "value": "Value of the markdown shown in form", + }, + Submit: &fBool, + Hide: &fBool, + }, + { + Type: "markdown", + ID: "id1", + Attributes: map[string]any{ + "value": "Value of the markdown shown in created issue", }, + Submit: &tBool, + Hide: &tBool, }, }, FileName: "test.yaml", @@ -515,6 +548,8 @@ body: Attributes: map[string]any{ "value": "Value of the markdown", }, + Submit: &fBool, + Hide: &fBool, }, }, FileName: "test.yaml", @@ -548,6 +583,8 @@ body: Attributes: map[string]any{ "value": "Value of the markdown", }, + Submit: &fBool, + Hide: &fBool, }, }, FileName: "test.yaml", @@ -622,9 +659,15 @@ body: - type: markdown id: id1 attributes: - value: Value of the markdown - - type: textarea + value: Value of the markdown shown in form + - type: markdown id: id2 + attributes: + value: Value of the markdown shown in created issue + hide: true + submit: true + - type: textarea + id: id3 attributes: label: Label of textarea description: Description of textarea @@ -634,7 +677,7 @@ body: validations: required: true - type: input - id: id3 + id: id4 attributes: label: Label of input description: Description of input @@ -646,7 +689,7 @@ body: is_number: true regex: "[a-zA-Z0-9]+" - type: dropdown - id: id4 + id: id5 attributes: label: Label of dropdown description: Description of dropdown @@ -658,7 +701,7 @@ body: validations: required: true - type: checkboxes - id: id5 + id: id6 attributes: label: Label of checkboxes description: Description of checkboxes @@ -669,20 +712,25 @@ body: required: false - label: Option 3 of checkboxes required: true + submit: false + - label: Hidden Option of checkboxes + hide: true `, values: map[string][]string{ - "form-field-id2": {"Value of id2"}, "form-field-id3": {"Value of id3"}, - "form-field-id4": {"0,1"}, - "form-field-id5-0": {"on"}, - "form-field-id5-2": {"on"}, + "form-field-id4": {"Value of id4"}, + "form-field-id5": {"0,1"}, + "form-field-id6-0": {"on"}, + "form-field-id6-2": {"on"}, }, }, want: `### Label of textarea ` + "```bash\nValue of id2\n```" + ` -Value of id3 +Value of the markdown shown in created issue + +Value of id4 ### Label of dropdown @@ -692,7 +740,7 @@ Option 1 of dropdown, Option 2 of dropdown - [x] Option 1 of checkboxes - [ ] Option 2 of checkboxes -- [x] Option 3 of checkboxes +- [ ] Hidden Option of checkboxes `, }, From a4c271379057050c630ffcb3271d8991c5b95823 Mon Sep 17 00:00:00 2001 From: "m.huber" Date: Tue, 20 Feb 2024 10:11:53 +0100 Subject: [PATCH 14/32] simplify --- modules/issue/template/unmarshal.go | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/modules/issue/template/unmarshal.go b/modules/issue/template/unmarshal.go index 3154d9b6d65a..deeac7908c2b 100644 --- a/modules/issue/template/unmarshal.go +++ b/modules/issue/template/unmarshal.go @@ -134,11 +134,8 @@ func unmarshal(filename string, content []byte) (*api.IssueTemplate, error) { } // set default submit value if v.Submit == nil { - submit := true // markdown is not submitted by default - if v.Type == api.IssueFormFieldTypeMarkdown { - submit = false - } + submit := v.Type != api.IssueFormFieldTypeMarkdown v.Submit = &submit } // set default hide value From c56c14065d1e0e7e7e0d68cefc060f9d4c0a4d9b Mon Sep 17 00:00:00 2001 From: "m.huber" Date: Tue, 20 Feb 2024 10:27:48 +0100 Subject: [PATCH 15/32] finish unit-test adjustments --- modules/issue/template/template.go | 4 ++-- modules/issue/template/template_test.go | 16 +++++++++------- 2 files changed, 11 insertions(+), 9 deletions(-) diff --git a/modules/issue/template/template.go b/modules/issue/template/template.go index 8faefa355f4e..f73829cc0474 100644 --- a/modules/issue/template/template.go +++ b/modules/issue/template/template.go @@ -313,8 +313,8 @@ func (f *valuedField) WriteTo(builder *strings.Builder) { _, _ = fmt.Fprintf(builder, "%s\n", value) } case api.IssueFormFieldTypeMarkdown: - if v, ok := f.Attributes["value"].(string); ok { - _, _ = fmt.Fprint(builder, v) + if value, ok := f.Attributes["value"].(string); ok { + _, _ = fmt.Fprintf(builder, "%s\n", value) } } _, _ = fmt.Fprintln(builder) diff --git a/modules/issue/template/template_test.go b/modules/issue/template/template_test.go index d4a4e62bbeea..71df85e1f4d2 100644 --- a/modules/issue/template/template_test.go +++ b/modules/issue/template/template_test.go @@ -10,6 +10,7 @@ import ( "code.gitea.io/gitea/modules/json" api "code.gitea.io/gitea/modules/structs" + "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" ) @@ -459,8 +460,8 @@ body: "options": []any{ map[string]any{"label": "Option 1 of checkboxes", "required": true}, map[string]any{"label": "Option 2 of checkboxes", "required": false}, - map[string]any{"label": "Option 3 of checkboxes", "required": false, "hide": true}, - map[string]any{"label": "Required but not submitted", "required": false, "submit": false}, + map[string]any{"label": "Hidden Option 3 of checkboxes", "hide": true}, + map[string]any{"label": "Required but not submitted", "required": true, "submit": false}, }, }, Submit: &tBool, @@ -509,7 +510,7 @@ body: }, { Type: "markdown", - ID: "id1", + ID: "id2", Attributes: map[string]any{ "value": "Value of the markdown shown in created issue", }, @@ -724,11 +725,12 @@ body: "form-field-id6-2": {"on"}, }, }, - want: `### Label of textarea -` + "```bash\nValue of id2\n```" + ` + want: `Value of the markdown shown in created issue + +### Label of textarea -Value of the markdown shown in created issue +` + "```bash\nValue of id3\n```" + ` Value of id4 @@ -752,7 +754,7 @@ Option 1 of dropdown, Option 2 of dropdown t.Fatal(err) } if got := RenderToMarkdown(template, tt.args.values); got != tt.want { - t.Errorf("RenderToMarkdown() = %v, want %v", got, tt.want) + assert.EqualValues(t, tt.want, got) } }) } From a70fe233db5727c0987edff908826c90fa8d3f0c Mon Sep 17 00:00:00 2001 From: "m.huber" Date: Tue, 20 Feb 2024 10:49:44 +0100 Subject: [PATCH 16/32] check agains required and hidden fields --- modules/issue/template/template.go | 8 +++++++- modules/issue/template/template_test.go | 16 ++++++++++++++++ 2 files changed, 23 insertions(+), 1 deletion(-) diff --git a/modules/issue/template/template.go b/modules/issue/template/template.go index f73829cc0474..80bc819bee4c 100644 --- a/modules/issue/template/template.go +++ b/modules/issue/template/template.go @@ -122,7 +122,13 @@ func validateRequired(field *api.IssueFormField, idx int) error { // The label is not required for a markdown or checkboxes field return nil } - return validateBoolItem(newErrorPosition(idx, field.Type), field.Validations, "required") + if err := validateBoolItem(newErrorPosition(idx, field.Type), field.Validations, "required"); err != nil { + return err + } + if required, _ := field.Validations["required"].(bool); required && field.Hide != nil && *field.Hide { + return newErrorPosition(idx, field.Type).Errorf("can not require a hidden field") + } + return nil } func validateID(field *api.IssueFormField, idx int, ids container.Set[string]) error { diff --git a/modules/issue/template/template_test.go b/modules/issue/template/template_test.go index 71df85e1f4d2..72d6315f72e1 100644 --- a/modules/issue/template/template_test.go +++ b/modules/issue/template/template_test.go @@ -321,6 +321,22 @@ body: `, wantErr: "body[0](checkboxes), option[0]: 'required' should be a bool", }, + { + name: "field is required but hidden", + content: ` +name: "test" +about: "this is about" +body: + - type: "input" + id: "1" + attributes: + label: "a" + validations: + required: true + hide: true +`, + wantErr: "body[0](input): can not require a hidden field", + }, { name: "valid", content: ` From b2119ac195de8716eaa0a8f984879d775845862d Mon Sep 17 00:00:00 2001 From: "m.huber" Date: Tue, 20 Feb 2024 13:47:47 +0100 Subject: [PATCH 17/32] hide -> hide_on_form --- .../issue-pull-request-templates.en-us.md | 30 ++++++------ modules/issue/template/template.go | 6 +-- modules/issue/template/template_test.go | 46 +++++++++---------- modules/issue/template/unmarshal.go | 4 +- modules/structs/issue.go | 2 +- templates/repo/issue/fields/checkboxes.tmpl | 2 +- 6 files changed, 45 insertions(+), 45 deletions(-) diff --git a/docs/content/usage/issue-pull-request-templates.en-us.md b/docs/content/usage/issue-pull-request-templates.en-us.md index 80b9d9108afa..d60fd5bec41a 100644 --- a/docs/content/usage/issue-pull-request-templates.en-us.md +++ b/docs/content/usage/issue-pull-request-templates.en-us.md @@ -135,12 +135,12 @@ body: attributes: value: | Thanks for taking the time to fill out this bug report! -# some markdown witch will be visible only in the created issue + # some markdown witch will be visible only in the created issue - type: markdown attributes: value: | This issue git created by an issue **template** :) - hide: true + hide_on_form: true submit: true - type: input id: contact @@ -197,7 +197,7 @@ body: required: true submit: false - label: This is a TODO only visible after issue creation - hide: true + hide_on_form: true ``` ### Markdown @@ -212,7 +212,7 @@ Attributes: Submit: Default is **false** -Hide: Default is **false** +hide_on_form: Default is **false** ### Textarea @@ -236,7 +236,7 @@ Validations: Submit: Default is **true** -Hide: Default is **false** +hide_on_form: Default is **false** ### Input @@ -261,7 +261,7 @@ Validations: Submit: Default is **true** -Hide: Default is **false** +hide_on_form: Default is **false** ### Dropdown @@ -284,7 +284,7 @@ Validations: Submit: Default is **true** -Hide: Default is **false** +hide_on_form: Default is **false** ### Checkboxes @@ -293,23 +293,23 @@ You can use the `checkboxes` element to add a set of checkboxes to your form. Attributes: | Key | Description | Required | Type | Default | Valid values | -|-------------|-------------------------------------------------------------------------------------------------------|----------|--------|--------------|--------------| +| ----------- | ----------------------------------------------------------------------------------------------------- | -------- | ------ | ------------ | ------------ | | label | A brief description of the expected user input, which is displayed in the form. | Required | String | - | - | | description | A description of the set of checkboxes, which is displayed in the form. Supports Markdown formatting. | Optional | String | Empty String | - | | options | An array of checkboxes that the user can select. For syntax, see below. | Required | Array | - | - | For each value in the options array, you can set the following keys. -| Key | Description | Required | Type | Default | Options | -|----------|------------------------------------------------------------------------------------------------------------------------------------------|----------|---------|---------|---------| -| label | The identifier for the option, which is displayed in the form. Markdown is supported for bold or italic text formatting, and hyperlinks. | Required | String | - | - | -| required | Prevents form submission until element is completed. | Optional | Boolean | false | - | -| submit | The specific checkbox that is rendered, will be submitted. | Optional | Boolean | true | - | -| hide | Do not render in the from. | Optional | Boolean | false | - | +| Key | Description | Required | Type | Default | Options | +|--------------|------------------------------------------------------------------------------------------------------------------------------------------|----------|---------|---------|---------| +| label | The identifier for the option, which is displayed in the form. Markdown is supported for bold or italic text formatting, and hyperlinks. | Required | String | - | - | +| required | Prevents form submission until element is completed. | Optional | Boolean | false | - | +| submit | The specific checkbox that is rendered, will be submitted. | Optional | Boolean | true | - | +| hide_on_form | Do not render in the from. | Optional | Boolean | false | - | Submit: Default is **true** -Hide: Default is **false** +hide_on_form: Default is **false** ## Syntax for issue config diff --git a/modules/issue/template/template.go b/modules/issue/template/template.go index 80bc819bee4c..5c1ad6ec5af1 100644 --- a/modules/issue/template/template.go +++ b/modules/issue/template/template.go @@ -125,7 +125,7 @@ func validateRequired(field *api.IssueFormField, idx int) error { if err := validateBoolItem(newErrorPosition(idx, field.Type), field.Validations, "required"); err != nil { return err } - if required, _ := field.Validations["required"].(bool); required && field.Hide != nil && *field.Hide { + if required, _ := field.Validations["required"].(bool); required && field.HideOnForm != nil && *field.HideOnForm { return newErrorPosition(idx, field.Type).Errorf("can not require a hidden field") } return nil @@ -190,9 +190,9 @@ func validateOptions(field *api.IssueFormField, idx int) error { } } - if hide, ok := opt["hide"]; ok { + if hide, ok := opt["hide_on_form"]; ok { if _, ok := hide.(bool); !ok { - return position.Errorf("'hide' should be a bool") + return position.Errorf("'hide_on_form' should be a bool") } } } diff --git a/modules/issue/template/template_test.go b/modules/issue/template/template_test.go index 72d6315f72e1..bc9507e88ec6 100644 --- a/modules/issue/template/template_test.go +++ b/modules/issue/template/template_test.go @@ -333,7 +333,7 @@ body: label: "a" validations: required: true - hide: true + hide_on_form: true `, wantErr: "body[0](input): can not require a hidden field", }, @@ -394,7 +394,7 @@ body: - label: Option 2 of checkboxes required: false - label: Hidden Option 3 of checkboxes - hide: true + hide_on_form: true - label: Required but not submitted required: true submit: false @@ -412,8 +412,8 @@ body: Attributes: map[string]any{ "value": "Value of the markdown", }, - Submit: &fBool, - Hide: &fBool, + Submit: &fBool, + HideOnForm: &fBool, }, { Type: "textarea", @@ -428,8 +428,8 @@ body: Validations: map[string]any{ "required": true, }, - Submit: &tBool, - Hide: &fBool, + Submit: &tBool, + HideOnForm: &fBool, }, { Type: "input", @@ -445,8 +445,8 @@ body: "is_number": true, "regex": "[a-zA-Z0-9]+", }, - Submit: &tBool, - Hide: &fBool, + Submit: &tBool, + HideOnForm: &fBool, }, { Type: "dropdown", @@ -464,8 +464,8 @@ body: Validations: map[string]any{ "required": true, }, - Submit: &tBool, - Hide: &fBool, + Submit: &tBool, + HideOnForm: &fBool, }, { Type: "checkboxes", @@ -480,8 +480,8 @@ body: map[string]any{"label": "Required but not submitted", "required": true, "submit": false}, }, }, - Submit: &tBool, - Hide: &fBool, + Submit: &tBool, + HideOnForm: &fBool, }, }, FileName: "test.yaml", @@ -505,7 +505,7 @@ body: id: id2 attributes: value: Value of the markdown shown in created issue - hide: true + hide_on_form: true submit: true `, want: &api.IssueTemplate{ @@ -521,8 +521,8 @@ body: Attributes: map[string]any{ "value": "Value of the markdown shown in form", }, - Submit: &fBool, - Hide: &fBool, + Submit: &fBool, + HideOnForm: &fBool, }, { Type: "markdown", @@ -530,8 +530,8 @@ body: Attributes: map[string]any{ "value": "Value of the markdown shown in created issue", }, - Submit: &tBool, - Hide: &tBool, + Submit: &tBool, + HideOnForm: &tBool, }, }, FileName: "test.yaml", @@ -565,8 +565,8 @@ body: Attributes: map[string]any{ "value": "Value of the markdown", }, - Submit: &fBool, - Hide: &fBool, + Submit: &fBool, + HideOnForm: &fBool, }, }, FileName: "test.yaml", @@ -600,8 +600,8 @@ body: Attributes: map[string]any{ "value": "Value of the markdown", }, - Submit: &fBool, - Hide: &fBool, + Submit: &fBool, + HideOnForm: &fBool, }, }, FileName: "test.yaml", @@ -681,7 +681,7 @@ body: id: id2 attributes: value: Value of the markdown shown in created issue - hide: true + hide_on_form: true submit: true - type: textarea id: id3 @@ -731,7 +731,7 @@ body: required: true submit: false - label: Hidden Option of checkboxes - hide: true + hide_on_form: true `, values: map[string][]string{ "form-field-id3": {"Value of id3"}, diff --git a/modules/issue/template/unmarshal.go b/modules/issue/template/unmarshal.go index deeac7908c2b..59344e1fc060 100644 --- a/modules/issue/template/unmarshal.go +++ b/modules/issue/template/unmarshal.go @@ -139,8 +139,8 @@ func unmarshal(filename string, content []byte) (*api.IssueTemplate, error) { v.Submit = &submit } // set default hide value - if v.Hide == nil { - v.Hide = new(bool) // set false + if v.HideOnForm == nil { + v.HideOnForm = new(bool) // set false } } } diff --git a/modules/structs/issue.go b/modules/structs/issue.go index 06c92f0198b5..26d9dc4b7f24 100644 --- a/modules/structs/issue.go +++ b/modules/structs/issue.go @@ -146,7 +146,7 @@ type IssueFormField struct { Attributes map[string]any `json:"attributes" yaml:"attributes"` Validations map[string]any `json:"validations" yaml:"validations"` Submit *bool `json:"submit,omitempty" yaml:"submit,omitempty"` - Hide *bool `json:"hide,omitempty" yaml:"hide,omitempty"` + HideOnForm *bool `json:"hide_on_form,omitempty" yaml:"hide_on_form,omitempty"` } // IssueTemplate represents an issue template for a repository diff --git a/templates/repo/issue/fields/checkboxes.tmpl b/templates/repo/issue/fields/checkboxes.tmpl index 1261a262e558..130f5288563d 100644 --- a/templates/repo/issue/fields/checkboxes.tmpl +++ b/templates/repo/issue/fields/checkboxes.tmpl @@ -2,7 +2,7 @@ {{template "repo/issue/fields/header" .}} {{range $i, $opt := .item.Attributes.options}}
-
+
From 1e00be7aafb334fab9a848e1c77833c05904a936 Mon Sep 17 00:00:00 2001 From: "m.huber" Date: Tue, 20 Feb 2024 14:07:31 +0100 Subject: [PATCH 18/32] submit -> skip_submit --- .../issue-pull-request-templates.en-us.md | 16 +++++------ modules/issue/template/template.go | 20 ++++++------- modules/issue/template/template_test.go | 28 +++++++++---------- modules/issue/template/unmarshal.go | 6 ++-- modules/structs/issue.go | 2 +- 5 files changed, 36 insertions(+), 36 deletions(-) diff --git a/docs/content/usage/issue-pull-request-templates.en-us.md b/docs/content/usage/issue-pull-request-templates.en-us.md index d60fd5bec41a..2b5e95bc5b53 100644 --- a/docs/content/usage/issue-pull-request-templates.en-us.md +++ b/docs/content/usage/issue-pull-request-templates.en-us.md @@ -141,7 +141,7 @@ body: value: | This issue git created by an issue **template** :) hide_on_form: true - submit: true + skip_submit: false - type: input id: contact attributes: @@ -195,7 +195,7 @@ body: required: true - label: I also have read the CONTRIBUTION.MD required: true - submit: false + skip_submit: true - label: This is a TODO only visible after issue creation hide_on_form: true ``` @@ -210,7 +210,7 @@ Attributes: |-------|--------------------------------------------------------------|----------|--------|---------|--------------| | value | The text that is rendered. Markdown formatting is supported. | Required | String | - | - | -Submit: Default is **false** +skip_submit: Default is **true** hide_on_form: Default is **false** @@ -234,7 +234,7 @@ Validations: |----------|------------------------------------------------------|----------|---------|---------|--------------| | required | Prevents form submission until element is completed. | Optional | Boolean | false | - | -Submit: Default is **true** +skip_submit: Default is **false** hide_on_form: Default is **false** @@ -259,7 +259,7 @@ Validations: | is_number | Prevents form submission until element is filled with a number. | Optional | Boolean | false | - | | regex | Prevents form submission until element is filled with a value that match the regular expression. | Optional | String | - | a [regular expression](https://en.wikipedia.org/wiki/Regular_expression) | -Submit: Default is **true** +skip_submit: Default is **false** hide_on_form: Default is **false** @@ -282,7 +282,7 @@ Validations: |----------|------------------------------------------------------|----------|---------|---------|--------------| | required | Prevents form submission until element is completed. | Optional | Boolean | false | - | -Submit: Default is **true** +skip_submit: Default is **false** hide_on_form: Default is **false** @@ -304,10 +304,10 @@ For each value in the options array, you can set the following keys. |--------------|------------------------------------------------------------------------------------------------------------------------------------------|----------|---------|---------|---------| | label | The identifier for the option, which is displayed in the form. Markdown is supported for bold or italic text formatting, and hyperlinks. | Required | String | - | - | | required | Prevents form submission until element is completed. | Optional | Boolean | false | - | -| submit | The specific checkbox that is rendered, will be submitted. | Optional | Boolean | true | - | +| skip_submit | The specific checkbox that is rendered, will not be submitted. | Optional | Boolean | false | - | | hide_on_form | Do not render in the from. | Optional | Boolean | false | - | -Submit: Default is **true** +skip_submit: Default is **false** hide_on_form: Default is **false** diff --git a/modules/issue/template/template.go b/modules/issue/template/template.go index 5c1ad6ec5af1..7b58c93dafe5 100644 --- a/modules/issue/template/template.go +++ b/modules/issue/template/template.go @@ -184,9 +184,9 @@ func validateOptions(field *api.IssueFormField, idx int) error { } } - if submit, ok := opt["submit"]; ok { - if _, ok := submit.(bool); !ok { - return position.Errorf("'submit' should be a bool") + if skipSubmit, ok := opt["skip_submit"]; ok { + if _, ok := skipSubmit.(bool); !ok { + return position.Errorf("'skip_submit' should be a bool") } } @@ -282,7 +282,7 @@ func (f *valuedField) WriteTo(builder *strings.Builder) { switch f.Type { case api.IssueFormFieldTypeCheckboxes: for _, option := range f.Options() { - if !option.Submit() { + if option.NoSubmit() { continue } checked := " " @@ -335,11 +335,11 @@ func (f *valuedField) Label() string { func (f *valuedField) NoSubmit() bool { // handle default case - if f.Submit == nil { + if f.SkipSubmit == nil { // markdown blocks do not appear in output by default - return f.Type == api.IssueFormFieldTypeMarkdown + return f.Type != api.IssueFormFieldTypeMarkdown } - return !*f.Submit + return *f.SkipSubmit } func (f *valuedField) HideLabel() bool { @@ -417,15 +417,15 @@ func (o *valuedOption) IsChecked() bool { return false } -func (o *valuedOption) Submit() bool { +func (o *valuedOption) NoSubmit() bool { if o.field.Type == api.IssueFormFieldTypeCheckboxes { if vs, ok := o.data.(map[string]any); ok { - if v, ok := vs["submit"].(bool); ok { + if v, ok := vs["skip_submit"].(bool); ok { return v } } } - return true + return false } var minQuotesRegex = regexp.MustCompilePOSIX("^`{3,}") diff --git a/modules/issue/template/template_test.go b/modules/issue/template/template_test.go index bc9507e88ec6..10b02478d17b 100644 --- a/modules/issue/template/template_test.go +++ b/modules/issue/template/template_test.go @@ -397,7 +397,7 @@ body: hide_on_form: true - label: Required but not submitted required: true - submit: false + skip_submit: true `, want: &api.IssueTemplate{ Name: "Name", @@ -412,7 +412,7 @@ body: Attributes: map[string]any{ "value": "Value of the markdown", }, - Submit: &fBool, + SkipSubmit: &tBool, HideOnForm: &fBool, }, { @@ -428,7 +428,7 @@ body: Validations: map[string]any{ "required": true, }, - Submit: &tBool, + SkipSubmit: &fBool, HideOnForm: &fBool, }, { @@ -445,7 +445,7 @@ body: "is_number": true, "regex": "[a-zA-Z0-9]+", }, - Submit: &tBool, + SkipSubmit: &fBool, HideOnForm: &fBool, }, { @@ -464,7 +464,7 @@ body: Validations: map[string]any{ "required": true, }, - Submit: &tBool, + SkipSubmit: &fBool, HideOnForm: &fBool, }, { @@ -477,10 +477,10 @@ body: map[string]any{"label": "Option 1 of checkboxes", "required": true}, map[string]any{"label": "Option 2 of checkboxes", "required": false}, map[string]any{"label": "Hidden Option 3 of checkboxes", "hide": true}, - map[string]any{"label": "Required but not submitted", "required": true, "submit": false}, + map[string]any{"label": "Required but not submitted", "required": true, "skip_submit": true}, }, }, - Submit: &tBool, + SkipSubmit: &fBool, HideOnForm: &fBool, }, }, @@ -506,7 +506,7 @@ body: attributes: value: Value of the markdown shown in created issue hide_on_form: true - submit: true + skip_submit: false `, want: &api.IssueTemplate{ Name: "Name", @@ -521,7 +521,7 @@ body: Attributes: map[string]any{ "value": "Value of the markdown shown in form", }, - Submit: &fBool, + SkipSubmit: &tBool, HideOnForm: &fBool, }, { @@ -530,7 +530,7 @@ body: Attributes: map[string]any{ "value": "Value of the markdown shown in created issue", }, - Submit: &tBool, + SkipSubmit: &fBool, HideOnForm: &tBool, }, }, @@ -565,7 +565,7 @@ body: Attributes: map[string]any{ "value": "Value of the markdown", }, - Submit: &fBool, + SkipSubmit: &tBool, HideOnForm: &fBool, }, }, @@ -600,7 +600,7 @@ body: Attributes: map[string]any{ "value": "Value of the markdown", }, - Submit: &fBool, + SkipSubmit: &tBool, HideOnForm: &fBool, }, }, @@ -682,7 +682,7 @@ body: attributes: value: Value of the markdown shown in created issue hide_on_form: true - submit: true + skip_submit: false - type: textarea id: id3 attributes: @@ -729,7 +729,7 @@ body: required: false - label: Option 3 of checkboxes required: true - submit: false + skip_submit: true - label: Hidden Option of checkboxes hide_on_form: true `, diff --git a/modules/issue/template/unmarshal.go b/modules/issue/template/unmarshal.go index 59344e1fc060..55f42a0c4617 100644 --- a/modules/issue/template/unmarshal.go +++ b/modules/issue/template/unmarshal.go @@ -133,10 +133,10 @@ func unmarshal(filename string, content []byte) (*api.IssueTemplate, error) { v.ID = strconv.Itoa(i) } // set default submit value - if v.Submit == nil { + if v.SkipSubmit == nil { // markdown is not submitted by default - submit := v.Type != api.IssueFormFieldTypeMarkdown - v.Submit = &submit + skipSubmit := v.Type == api.IssueFormFieldTypeMarkdown + v.SkipSubmit = &skipSubmit } // set default hide value if v.HideOnForm == nil { diff --git a/modules/structs/issue.go b/modules/structs/issue.go index 26d9dc4b7f24..1ce3f3717224 100644 --- a/modules/structs/issue.go +++ b/modules/structs/issue.go @@ -145,7 +145,7 @@ type IssueFormField struct { ID string `json:"id" yaml:"id"` Attributes map[string]any `json:"attributes" yaml:"attributes"` Validations map[string]any `json:"validations" yaml:"validations"` - Submit *bool `json:"submit,omitempty" yaml:"submit,omitempty"` + SkipSubmit *bool `json:"skip_submit,omitempty" yaml:"skip_submit,omitempty"` HideOnForm *bool `json:"hide_on_form,omitempty" yaml:"hide_on_form,omitempty"` } From 13b1bcc524d86b4f363a5ed6a49b1326dfc68a4e Mon Sep 17 00:00:00 2001 From: "m.huber" Date: Tue, 20 Feb 2024 15:15:44 +0100 Subject: [PATCH 19/32] update templates --- modules/issue/template/template.go | 2 +- modules/issue/template/template_test.go | 18 +++++++++--------- modules/issue/template/unmarshal.go | 4 ---- modules/structs/issue.go | 2 +- modules/templates/helper.go | 9 --------- templates/repo/issue/fields/checkboxes.tmpl | 2 +- templates/repo/issue/fields/dropdown.tmpl | 2 +- templates/repo/issue/fields/input.tmpl | 2 +- templates/repo/issue/fields/markdown.tmpl | 2 +- templates/repo/issue/fields/textarea.tmpl | 2 +- templates/swagger/v1_json.tmpl | 8 ++++---- 11 files changed, 20 insertions(+), 33 deletions(-) diff --git a/modules/issue/template/template.go b/modules/issue/template/template.go index 7b58c93dafe5..83717abe19dd 100644 --- a/modules/issue/template/template.go +++ b/modules/issue/template/template.go @@ -125,7 +125,7 @@ func validateRequired(field *api.IssueFormField, idx int) error { if err := validateBoolItem(newErrorPosition(idx, field.Type), field.Validations, "required"); err != nil { return err } - if required, _ := field.Validations["required"].(bool); required && field.HideOnForm != nil && *field.HideOnForm { + if required, _ := field.Validations["required"].(bool); required && field.HideOnForm { return newErrorPosition(idx, field.Type).Errorf("can not require a hidden field") } return nil diff --git a/modules/issue/template/template_test.go b/modules/issue/template/template_test.go index 10b02478d17b..8d92f9141712 100644 --- a/modules/issue/template/template_test.go +++ b/modules/issue/template/template_test.go @@ -413,7 +413,7 @@ body: "value": "Value of the markdown", }, SkipSubmit: &tBool, - HideOnForm: &fBool, + HideOnForm: false, }, { Type: "textarea", @@ -429,7 +429,7 @@ body: "required": true, }, SkipSubmit: &fBool, - HideOnForm: &fBool, + HideOnForm: false, }, { Type: "input", @@ -446,7 +446,7 @@ body: "regex": "[a-zA-Z0-9]+", }, SkipSubmit: &fBool, - HideOnForm: &fBool, + HideOnForm: false, }, { Type: "dropdown", @@ -465,7 +465,7 @@ body: "required": true, }, SkipSubmit: &fBool, - HideOnForm: &fBool, + HideOnForm: false, }, { Type: "checkboxes", @@ -481,7 +481,7 @@ body: }, }, SkipSubmit: &fBool, - HideOnForm: &fBool, + HideOnForm: false, }, }, FileName: "test.yaml", @@ -522,7 +522,7 @@ body: "value": "Value of the markdown shown in form", }, SkipSubmit: &tBool, - HideOnForm: &fBool, + HideOnForm: false, }, { Type: "markdown", @@ -531,7 +531,7 @@ body: "value": "Value of the markdown shown in created issue", }, SkipSubmit: &fBool, - HideOnForm: &tBool, + HideOnForm: true, }, }, FileName: "test.yaml", @@ -566,7 +566,7 @@ body: "value": "Value of the markdown", }, SkipSubmit: &tBool, - HideOnForm: &fBool, + HideOnForm: false, }, }, FileName: "test.yaml", @@ -601,7 +601,7 @@ body: "value": "Value of the markdown", }, SkipSubmit: &tBool, - HideOnForm: &fBool, + HideOnForm: false, }, }, FileName: "test.yaml", diff --git a/modules/issue/template/unmarshal.go b/modules/issue/template/unmarshal.go index 55f42a0c4617..92bc7234e802 100644 --- a/modules/issue/template/unmarshal.go +++ b/modules/issue/template/unmarshal.go @@ -138,10 +138,6 @@ func unmarshal(filename string, content []byte) (*api.IssueTemplate, error) { skipSubmit := v.Type == api.IssueFormFieldTypeMarkdown v.SkipSubmit = &skipSubmit } - // set default hide value - if v.HideOnForm == nil { - v.HideOnForm = new(bool) // set false - } } } diff --git a/modules/structs/issue.go b/modules/structs/issue.go index 1ce3f3717224..654eef359e3c 100644 --- a/modules/structs/issue.go +++ b/modules/structs/issue.go @@ -146,7 +146,7 @@ type IssueFormField struct { Attributes map[string]any `json:"attributes" yaml:"attributes"` Validations map[string]any `json:"validations" yaml:"validations"` SkipSubmit *bool `json:"skip_submit,omitempty" yaml:"skip_submit,omitempty"` - HideOnForm *bool `json:"hide_on_form,omitempty" yaml:"hide_on_form,omitempty"` + HideOnForm bool `json:"hide_on_form" yaml:"hide_on_form"` } // IssueTemplate represents an issue template for a repository diff --git a/modules/templates/helper.go b/modules/templates/helper.go index cab164582941..6e42594b0b7d 100644 --- a/modules/templates/helper.go +++ b/modules/templates/helper.go @@ -176,18 +176,9 @@ func NewFuncMap() template.FuncMap { "FilenameIsImage": FilenameIsImage, "TabSizeClass": TabSizeClass, - "BoolPtrVal": PtrVal[bool], } } -// PtrVal return the value of an pointer or init a new empty one based on pointer type -func PtrVal[T any](ptr *T) T { - if ptr == nil { - ptr = new(T) - } - return *ptr -} - // Safe render raw as HTML func Safe(s any) template.HTML { switch v := s.(type) { diff --git a/templates/repo/issue/fields/checkboxes.tmpl b/templates/repo/issue/fields/checkboxes.tmpl index 130f5288563d..18d246eb5b00 100644 --- a/templates/repo/issue/fields/checkboxes.tmpl +++ b/templates/repo/issue/fields/checkboxes.tmpl @@ -1,4 +1,4 @@ -
+
{{template "repo/issue/fields/header" .}} {{range $i, $opt := .item.Attributes.options}}
diff --git a/templates/repo/issue/fields/dropdown.tmpl b/templates/repo/issue/fields/dropdown.tmpl index 914da5d75488..b89f0eae1625 100644 --- a/templates/repo/issue/fields/dropdown.tmpl +++ b/templates/repo/issue/fields/dropdown.tmpl @@ -1,4 +1,4 @@ -
+
{{template "repo/issue/fields/header" .}} {{/* FIXME: required validation */}}
diff --git a/templates/repo/issue/fields/input.tmpl b/templates/repo/issue/fields/input.tmpl index b514bcb66ca8..d54a980e6d19 100644 --- a/templates/repo/issue/fields/input.tmpl +++ b/templates/repo/issue/fields/input.tmpl @@ -1,4 +1,4 @@ -
+
{{template "repo/issue/fields/header" .}}
diff --git a/templates/repo/issue/fields/markdown.tmpl b/templates/repo/issue/fields/markdown.tmpl index d0763c7e20dc..41b7f98642b6 100644 --- a/templates/repo/issue/fields/markdown.tmpl +++ b/templates/repo/issue/fields/markdown.tmpl @@ -1,3 +1,3 @@ -
+
{{RenderMarkdownToHtml .Context .item.Attributes.value}}
diff --git a/templates/repo/issue/fields/textarea.tmpl b/templates/repo/issue/fields/textarea.tmpl index 749d97888132..d24b69d7c1a5 100644 --- a/templates/repo/issue/fields/textarea.tmpl +++ b/templates/repo/issue/fields/textarea.tmpl @@ -1,5 +1,5 @@ {{$useMarkdownEditor := not .item.Attributes.render}} -
+
{{template "repo/issue/fields/header" .}} {{/* the real form element to provide the value */}} diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl index f3a57c93ad45..83de1ff1eae1 100644 --- a/templates/swagger/v1_json.tmpl +++ b/templates/swagger/v1_json.tmpl @@ -20377,17 +20377,17 @@ "additionalProperties": {}, "x-go-name": "Attributes" }, - "hide": { + "hide_on_form": { "type": "boolean", - "x-go-name": "Hide" + "x-go-name": "HideOnForm" }, "id": { "type": "string", "x-go-name": "ID" }, - "submit": { + "skip_submit": { "type": "boolean", - "x-go-name": "Submit" + "x-go-name": "SkipSubmit" }, "type": { "$ref": "#/definitions/IssueFormFieldType" From a72ec6361ae2b85a45fc1cdcc0a06441f4decd3b Mon Sep 17 00:00:00 2001 From: "m.huber" Date: Tue, 20 Feb 2024 15:35:58 +0100 Subject: [PATCH 20/32] fix test --- modules/issue/template/template_test.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/issue/template/template_test.go b/modules/issue/template/template_test.go index 8d92f9141712..adbf237439b7 100644 --- a/modules/issue/template/template_test.go +++ b/modules/issue/template/template_test.go @@ -476,7 +476,7 @@ body: "options": []any{ map[string]any{"label": "Option 1 of checkboxes", "required": true}, map[string]any{"label": "Option 2 of checkboxes", "required": false}, - map[string]any{"label": "Hidden Option 3 of checkboxes", "hide": true}, + map[string]any{"label": "Hidden Option 3 of checkboxes", "hide_on_form": true}, map[string]any{"label": "Required but not submitted", "required": true, "skip_submit": true}, }, }, From 611dd7af78716dfa8c908114bf73a82083871db1 Mon Sep 17 00:00:00 2001 From: 6543 <6543@obermui.de> Date: Tue, 27 Feb 2024 19:34:28 +0100 Subject: [PATCH 21/32] Apply suggestions from code review Co-authored-by: John Olheiser --- docs/content/usage/issue-pull-request-templates.en-us.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/content/usage/issue-pull-request-templates.en-us.md b/docs/content/usage/issue-pull-request-templates.en-us.md index 6f4403810296..a867cb73005d 100644 --- a/docs/content/usage/issue-pull-request-templates.en-us.md +++ b/docs/content/usage/issue-pull-request-templates.en-us.md @@ -136,11 +136,11 @@ body: attributes: value: | Thanks for taking the time to fill out this bug report! - # some markdown witch will be visible only in the created issue + # some markdown which will be visible only in the created issue - type: markdown attributes: value: | - This issue git created by an issue **template** :) + This issue was created by an issue **template** :) hide_on_form: true skip_submit: false - type: input @@ -194,7 +194,7 @@ body: options: - label: I agree to follow this project's Code of Conduct required: true - - label: I also have read the CONTRIBUTION.MD + - label: I have also read the CONTRIBUTION.MD required: true skip_submit: true - label: This is a TODO only visible after issue creation @@ -306,7 +306,7 @@ For each value in the options array, you can set the following keys. | label | The identifier for the option, which is displayed in the form. Markdown is supported for bold or italic text formatting, and hyperlinks. | Required | String | - | - | | required | Prevents form submission until element is completed. | Optional | Boolean | false | - | | skip_submit | The specific checkbox that is rendered, will not be submitted. | Optional | Boolean | false | - | -| hide_on_form | Do not render in the from. | Optional | Boolean | false | - | +| hide_on_form | Do not render in the form. | Optional | Boolean | false | - | skip_submit: Default is **false** From 58a728f78af15bb804797b10941945deba37d53e Mon Sep 17 00:00:00 2001 From: 6543 <6543@obermui.de> Date: Fri, 1 Mar 2024 18:17:52 +0100 Subject: [PATCH 22/32] migrate to Visible in main issue form fields --- .../issue-pull-request-templates.en-us.md | 38 +++++++------------ modules/issue/template/template.go | 13 +------ modules/issue/template/unmarshal.go | 8 ++-- modules/structs/issue.go | 30 ++++++++++++++- templates/repo/issue/fields/checkboxes.tmpl | 2 +- templates/repo/issue/fields/dropdown.tmpl | 2 +- templates/repo/issue/fields/input.tmpl | 2 +- templates/repo/issue/fields/markdown.tmpl | 2 +- templates/repo/issue/fields/textarea.tmpl | 2 +- templates/swagger/v1_json.tmpl | 25 ++++++++---- 10 files changed, 70 insertions(+), 54 deletions(-) diff --git a/docs/content/usage/issue-pull-request-templates.en-us.md b/docs/content/usage/issue-pull-request-templates.en-us.md index a867cb73005d..c8b7ef285521 100644 --- a/docs/content/usage/issue-pull-request-templates.en-us.md +++ b/docs/content/usage/issue-pull-request-templates.en-us.md @@ -141,8 +141,7 @@ body: attributes: value: | This issue was created by an issue **template** :) - hide_on_form: true - skip_submit: false + visible: [content] - type: input id: contact attributes: @@ -196,9 +195,9 @@ body: required: true - label: I have also read the CONTRIBUTION.MD required: true - skip_submit: true + visible: [form] - label: This is a TODO only visible after issue creation - hide_on_form: true + visible: [content] ``` ### Markdown @@ -211,9 +210,7 @@ Attributes: |-------|--------------------------------------------------------------|----------|--------|---------|--------------| | value | The text that is rendered. Markdown formatting is supported. | Required | String | - | - | -skip_submit: Default is **true** - -hide_on_form: Default is **false** +visible: Default is **[form]** ### Textarea @@ -235,9 +232,7 @@ Validations: |----------|------------------------------------------------------|----------|---------|---------|--------------| | required | Prevents form submission until element is completed. | Optional | Boolean | false | - | -skip_submit: Default is **false** - -hide_on_form: Default is **false** +visible: Default is **[form, content]** ### Input @@ -260,9 +255,7 @@ Validations: | is_number | Prevents form submission until element is filled with a number. | Optional | Boolean | false | - | | regex | Prevents form submission until element is filled with a value that match the regular expression. | Optional | String | - | a [regular expression](https://en.wikipedia.org/wiki/Regular_expression) | -skip_submit: Default is **false** - -hide_on_form: Default is **false** +visible: Default is **[form, content]** ### Dropdown @@ -283,9 +276,7 @@ Validations: |----------|------------------------------------------------------|----------|---------|---------|--------------| | required | Prevents form submission until element is completed. | Optional | Boolean | false | - | -skip_submit: Default is **false** - -hide_on_form: Default is **false** +visible: Default is **[form, content]** ### Checkboxes @@ -301,16 +292,13 @@ Attributes: For each value in the options array, you can set the following keys. -| Key | Description | Required | Type | Default | Options | -|--------------|------------------------------------------------------------------------------------------------------------------------------------------|----------|---------|---------|---------| -| label | The identifier for the option, which is displayed in the form. Markdown is supported for bold or italic text formatting, and hyperlinks. | Required | String | - | - | -| required | Prevents form submission until element is completed. | Optional | Boolean | false | - | -| skip_submit | The specific checkbox that is rendered, will not be submitted. | Optional | Boolean | false | - | -| hide_on_form | Do not render in the form. | Optional | Boolean | false | - | - -skip_submit: Default is **false** +| Key | Description | Required | Type | Default | Options | +|--------------|------------------------------------------------------------------------------------------------------------------------------------------------|----------|--------------|---------|---------| +| label | The identifier for the option, which is displayed in the form. Markdown is supported for bold or italic text formatting, and hyperlinks. | Required | String | - | - | +| required | Prevents form submission until element is completed. | Optional | Boolean | false | - | +| visible | Set visible to a specific checkbox. Valid options are "form" to render in only in the form, "content" to have it in the created issue and both | Optional | String array | false | - | -hide_on_form: Default is **false** +visible: Default is **[form, content]** ## Syntax for issue config diff --git a/modules/issue/template/template.go b/modules/issue/template/template.go index 83717abe19dd..f7d09cf9aab4 100644 --- a/modules/issue/template/template.go +++ b/modules/issue/template/template.go @@ -125,7 +125,7 @@ func validateRequired(field *api.IssueFormField, idx int) error { if err := validateBoolItem(newErrorPosition(idx, field.Type), field.Validations, "required"); err != nil { return err } - if required, _ := field.Validations["required"].(bool); required && field.HideOnForm { + if required, _ := field.Validations["required"].(bool); required && !field.VisibleOnForm() { return newErrorPosition(idx, field.Type).Errorf("can not require a hidden field") } return nil @@ -256,7 +256,7 @@ func RenderToMarkdown(template *api.IssueTemplate, values url.Values) string { IssueFormField: field, Values: values, } - if f.ID == "" || f.NoSubmit() { + if f.ID == "" || !f.VisibleInContent() { continue } f.WriteTo(builder) @@ -333,15 +333,6 @@ func (f *valuedField) Label() string { return "" } -func (f *valuedField) NoSubmit() bool { - // handle default case - if f.SkipSubmit == nil { - // markdown blocks do not appear in output by default - return f.Type != api.IssueFormFieldTypeMarkdown - } - return *f.SkipSubmit -} - func (f *valuedField) HideLabel() bool { if f.Type == api.IssueFormFieldTypeMarkdown { return true diff --git a/modules/issue/template/unmarshal.go b/modules/issue/template/unmarshal.go index 92bc7234e802..cc13b49b1329 100644 --- a/modules/issue/template/unmarshal.go +++ b/modules/issue/template/unmarshal.go @@ -133,10 +133,12 @@ func unmarshal(filename string, content []byte) (*api.IssueTemplate, error) { v.ID = strconv.Itoa(i) } // set default submit value - if v.SkipSubmit == nil { + if v.Visible == nil { + v.Visible = []api.IssueFormFieldVisible{api.IssueFormFieldVisibleForm} // markdown is not submitted by default - skipSubmit := v.Type == api.IssueFormFieldTypeMarkdown - v.SkipSubmit = &skipSubmit + if v.Type != api.IssueFormFieldTypeMarkdown { + v.Visible = append(v.Visible, api.IssueFormFieldVisibleContent) + } } } } diff --git a/modules/structs/issue.go b/modules/structs/issue.go index 654eef359e3c..6272cc5143e6 100644 --- a/modules/structs/issue.go +++ b/modules/structs/issue.go @@ -6,6 +6,7 @@ package structs import ( "fmt" "path" + "slices" "strings" "time" @@ -145,10 +146,35 @@ type IssueFormField struct { ID string `json:"id" yaml:"id"` Attributes map[string]any `json:"attributes" yaml:"attributes"` Validations map[string]any `json:"validations" yaml:"validations"` - SkipSubmit *bool `json:"skip_submit,omitempty" yaml:"skip_submit,omitempty"` - HideOnForm bool `json:"hide_on_form" yaml:"hide_on_form"` + // enum: form,content + // default: [form,content] + Visible []IssueFormFieldVisible `json:"visible,omitempty"` } +func (iff IssueFormField) VisibleOnForm() bool { + if len(iff.Visible) == 0 { + return true + } + return slices.Contains(iff.Visible, IssueFormFieldVisibleForm) +} + +func (iff IssueFormField) VisibleInContent() bool { + if len(iff.Visible) == 0 { + // we have our markdown exception + return iff.Type != IssueFormFieldTypeMarkdown + } + return slices.Contains(iff.Visible, IssueFormFieldVisibleContent) +} + +// IssueFormFieldVisible defines issue form field visible +// swagger:model +type IssueFormFieldVisible string + +const ( + IssueFormFieldVisibleForm IssueFormFieldVisible = "form" + IssueFormFieldVisibleContent IssueFormFieldVisible = "content" +) + // IssueTemplate represents an issue template for a repository // swagger:model type IssueTemplate struct { diff --git a/templates/repo/issue/fields/checkboxes.tmpl b/templates/repo/issue/fields/checkboxes.tmpl index 18d246eb5b00..e6900af8d3c8 100644 --- a/templates/repo/issue/fields/checkboxes.tmpl +++ b/templates/repo/issue/fields/checkboxes.tmpl @@ -1,4 +1,4 @@ -
+
{{template "repo/issue/fields/header" .}} {{range $i, $opt := .item.Attributes.options}}
diff --git a/templates/repo/issue/fields/dropdown.tmpl b/templates/repo/issue/fields/dropdown.tmpl index b89f0eae1625..b8df6908e30e 100644 --- a/templates/repo/issue/fields/dropdown.tmpl +++ b/templates/repo/issue/fields/dropdown.tmpl @@ -1,4 +1,4 @@ -
+
{{template "repo/issue/fields/header" .}} {{/* FIXME: required validation */}}
diff --git a/templates/repo/issue/fields/input.tmpl b/templates/repo/issue/fields/input.tmpl index d54a980e6d19..ad0fe3d7835d 100644 --- a/templates/repo/issue/fields/input.tmpl +++ b/templates/repo/issue/fields/input.tmpl @@ -1,4 +1,4 @@ -
+
{{template "repo/issue/fields/header" .}}
diff --git a/templates/repo/issue/fields/markdown.tmpl b/templates/repo/issue/fields/markdown.tmpl index 41b7f98642b6..97813cc1d86a 100644 --- a/templates/repo/issue/fields/markdown.tmpl +++ b/templates/repo/issue/fields/markdown.tmpl @@ -1,3 +1,3 @@ -
+
{{RenderMarkdownToHtml .Context .item.Attributes.value}}
diff --git a/templates/repo/issue/fields/textarea.tmpl b/templates/repo/issue/fields/textarea.tmpl index d24b69d7c1a5..4f68b4038b6d 100644 --- a/templates/repo/issue/fields/textarea.tmpl +++ b/templates/repo/issue/fields/textarea.tmpl @@ -1,5 +1,5 @@ {{$useMarkdownEditor := not .item.Attributes.render}} -
+
{{template "repo/issue/fields/header" .}} {{/* the real form element to provide the value */}} diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl index d792aad7e7ac..be85c570d432 100644 --- a/templates/swagger/v1_json.tmpl +++ b/templates/swagger/v1_json.tmpl @@ -20612,18 +20612,10 @@ "additionalProperties": {}, "x-go-name": "Attributes" }, - "hide_on_form": { - "type": "boolean", - "x-go-name": "HideOnForm" - }, "id": { "type": "string", "x-go-name": "ID" }, - "skip_submit": { - "type": "boolean", - "x-go-name": "SkipSubmit" - }, "type": { "$ref": "#/definitions/IssueFormFieldType" }, @@ -20631,6 +20623,18 @@ "type": "object", "additionalProperties": {}, "x-go-name": "Validations" + }, + "visible": { + "type": "array", + "default": "[form,content]", + "enum": [ + "form", + "content" + ], + "items": { + "$ref": "#/definitions/IssueFormFieldVisible" + }, + "x-go-name": "Visible" } }, "x-go-package": "code.gitea.io/gitea/modules/structs" @@ -20640,6 +20644,11 @@ "title": "IssueFormFieldType defines issue form field type, can be \"markdown\", \"textarea\", \"input\", \"dropdown\" or \"checkboxes\"", "x-go-package": "code.gitea.io/gitea/modules/structs" }, + "IssueFormFieldVisible": { + "description": "IssueFormFieldVisible defines issue form field visible", + "type": "string", + "x-go-package": "code.gitea.io/gitea/modules/structs" + }, "IssueLabelsOption": { "description": "IssueLabelsOption a collection of labels", "type": "object", From 0e08e43678abfa9b6f9b2874f14ad21f53a51a47 Mon Sep 17 00:00:00 2001 From: 6543 <6543@obermui.de> Date: Fri, 1 Mar 2024 18:28:41 +0100 Subject: [PATCH 23/32] migrate to Visible in main issue forms [tests] --- modules/issue/template/template_test.go | 37 ++++++++----------------- 1 file changed, 12 insertions(+), 25 deletions(-) diff --git a/modules/issue/template/template_test.go b/modules/issue/template/template_test.go index adbf237439b7..9caee17de548 100644 --- a/modules/issue/template/template_test.go +++ b/modules/issue/template/template_test.go @@ -15,8 +15,6 @@ import ( ) func TestValidate(t *testing.T) { - fBool := false - tBool := true tests := []struct { name string filename string @@ -333,7 +331,7 @@ body: label: "a" validations: required: true - hide_on_form: true + visible: [content] `, wantErr: "body[0](input): can not require a hidden field", }, @@ -412,8 +410,7 @@ body: Attributes: map[string]any{ "value": "Value of the markdown", }, - SkipSubmit: &tBool, - HideOnForm: false, + Visible: []api.IssueFormFieldVisible{api.IssueFormFieldVisibleForm}, }, { Type: "textarea", @@ -428,8 +425,7 @@ body: Validations: map[string]any{ "required": true, }, - SkipSubmit: &fBool, - HideOnForm: false, + Visible: []api.IssueFormFieldVisible{api.IssueFormFieldVisibleForm, api.IssueFormFieldVisibleContent}, }, { Type: "input", @@ -445,8 +441,7 @@ body: "is_number": true, "regex": "[a-zA-Z0-9]+", }, - SkipSubmit: &fBool, - HideOnForm: false, + Visible: []api.IssueFormFieldVisible{api.IssueFormFieldVisibleForm, api.IssueFormFieldVisibleContent}, }, { Type: "dropdown", @@ -464,8 +459,7 @@ body: Validations: map[string]any{ "required": true, }, - SkipSubmit: &fBool, - HideOnForm: false, + Visible: []api.IssueFormFieldVisible{api.IssueFormFieldVisibleForm, api.IssueFormFieldVisibleContent}, }, { Type: "checkboxes", @@ -480,8 +474,7 @@ body: map[string]any{"label": "Required but not submitted", "required": true, "skip_submit": true}, }, }, - SkipSubmit: &fBool, - HideOnForm: false, + Visible: []api.IssueFormFieldVisible{api.IssueFormFieldVisibleForm, api.IssueFormFieldVisibleContent}, }, }, FileName: "test.yaml", @@ -505,8 +498,7 @@ body: id: id2 attributes: value: Value of the markdown shown in created issue - hide_on_form: true - skip_submit: false + visible: [content] `, want: &api.IssueTemplate{ Name: "Name", @@ -521,8 +513,7 @@ body: Attributes: map[string]any{ "value": "Value of the markdown shown in form", }, - SkipSubmit: &tBool, - HideOnForm: false, + Visible: []api.IssueFormFieldVisible{api.IssueFormFieldVisibleForm}, }, { Type: "markdown", @@ -530,8 +521,7 @@ body: Attributes: map[string]any{ "value": "Value of the markdown shown in created issue", }, - SkipSubmit: &fBool, - HideOnForm: true, + Visible: []api.IssueFormFieldVisible{api.IssueFormFieldVisibleContent}, }, }, FileName: "test.yaml", @@ -565,8 +555,7 @@ body: Attributes: map[string]any{ "value": "Value of the markdown", }, - SkipSubmit: &tBool, - HideOnForm: false, + Visible: []api.IssueFormFieldVisible{api.IssueFormFieldVisibleForm}, }, }, FileName: "test.yaml", @@ -600,8 +589,7 @@ body: Attributes: map[string]any{ "value": "Value of the markdown", }, - SkipSubmit: &tBool, - HideOnForm: false, + Visible: []api.IssueFormFieldVisible{api.IssueFormFieldVisibleForm}, }, }, FileName: "test.yaml", @@ -681,8 +669,7 @@ body: id: id2 attributes: value: Value of the markdown shown in created issue - hide_on_form: true - skip_submit: false + visible: [content] - type: textarea id: id3 attributes: From 8a0f25edb14e13fec1200806a8a9c7fd9478c07d Mon Sep 17 00:00:00 2001 From: 6543 <6543@obermui.de> Date: Fri, 1 Mar 2024 18:45:51 +0100 Subject: [PATCH 24/32] swagger docs: cant set enum for string type --- modules/structs/issue.go | 1 - templates/swagger/v1_json.tmpl | 4 ---- 2 files changed, 5 deletions(-) diff --git a/modules/structs/issue.go b/modules/structs/issue.go index 6272cc5143e6..cc213dc7a26b 100644 --- a/modules/structs/issue.go +++ b/modules/structs/issue.go @@ -146,7 +146,6 @@ type IssueFormField struct { ID string `json:"id" yaml:"id"` Attributes map[string]any `json:"attributes" yaml:"attributes"` Validations map[string]any `json:"validations" yaml:"validations"` - // enum: form,content // default: [form,content] Visible []IssueFormFieldVisible `json:"visible,omitempty"` } diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl index be85c570d432..e88fda7527bf 100644 --- a/templates/swagger/v1_json.tmpl +++ b/templates/swagger/v1_json.tmpl @@ -20627,10 +20627,6 @@ "visible": { "type": "array", "default": "[form,content]", - "enum": [ - "form", - "content" - ], "items": { "$ref": "#/definitions/IssueFormFieldVisible" }, From c675bc5f83ad6c656bac9bc3aab291c7a304db8f Mon Sep 17 00:00:00 2001 From: 6543 <6543@obermui.de> Date: Fri, 1 Mar 2024 19:30:36 +0100 Subject: [PATCH 25/32] handle checkboxes golang --- modules/issue/template/template.go | 51 +++++++++++++++++-------- modules/issue/template/template_test.go | 32 +++++++++++++--- 2 files changed, 62 insertions(+), 21 deletions(-) diff --git a/modules/issue/template/template.go b/modules/issue/template/template.go index f7d09cf9aab4..d27051b81949 100644 --- a/modules/issue/template/template.go +++ b/modules/issue/template/template.go @@ -178,21 +178,37 @@ func validateOptions(field *api.IssueFormField, idx int) error { return position.Errorf("'label' is required and should be a string") } - if required, ok := opt["required"]; ok { - if _, ok := required.(bool); !ok { - return position.Errorf("'required' should be a bool") + if visible, ok := opt["visible"]; ok { + visibleList, ok := visible.([]any) + if !ok { + return position.Errorf("'visible' should be list") + } + for _, visibleType := range visibleList { + visibleType, ok := visibleType.(string) + if !ok || !(visibleType == "form" || visibleType == "content") { + return position.Errorf("'visible' list can only contain strings of 'form' and 'content'") + } } } - if skipSubmit, ok := opt["skip_submit"]; ok { - if _, ok := skipSubmit.(bool); !ok { - return position.Errorf("'skip_submit' should be a bool") + if required, ok := opt["required"]; ok { + if _, ok := required.(bool); !ok { + return position.Errorf("'required' should be a bool") } - } - if hide, ok := opt["hide_on_form"]; ok { - if _, ok := hide.(bool); !ok { - return position.Errorf("'hide_on_form' should be a bool") + // validate if hidden field is required + if visible, ok := opt["visible"]; ok { + visibleList, _ := visible.([]any) + isVisible := false + for _, v := range visibleList { + if vv, _ := v.(string); vv == "form" { + isVisible = true + break + } + } + if !isVisible { + return position.Errorf("can not require a hidden checkbox") + } } } } @@ -282,7 +298,7 @@ func (f *valuedField) WriteTo(builder *strings.Builder) { switch f.Type { case api.IssueFormFieldTypeCheckboxes: for _, option := range f.Options() { - if option.NoSubmit() { + if !option.VisibleInContent() { continue } checked := " " @@ -408,15 +424,20 @@ func (o *valuedOption) IsChecked() bool { return false } -func (o *valuedOption) NoSubmit() bool { +func (o *valuedOption) VisibleInContent() bool { if o.field.Type == api.IssueFormFieldTypeCheckboxes { if vs, ok := o.data.(map[string]any); ok { - if v, ok := vs["skip_submit"].(bool); ok { - return v + if vl, ok := vs["visible"].([]any); ok { + for _, v := range vl { + if vv, _ := v.(string); vv == "content" { + return true + } + } + return false } } } - return false + return true } var minQuotesRegex = regexp.MustCompilePOSIX("^`{3,}") diff --git a/modules/issue/template/template_test.go b/modules/issue/template/template_test.go index 9caee17de548..e24b962d61b7 100644 --- a/modules/issue/template/template_test.go +++ b/modules/issue/template/template_test.go @@ -335,6 +335,26 @@ body: `, wantErr: "body[0](input): can not require a hidden field", }, + { + name: "checkboxes is required but hidden", + content: ` +name: "test" +about: "this is about" +body: + - type: checkboxes + id: "1" + attributes: + label: Label of checkboxes + description: Description of checkboxes + options: + - label: Option 1 + required: false + - label: Required and hidden + required: true + visible: [content] +`, + wantErr: "body[0](checkboxes), option[1]: can not require a hidden checkbox", + }, { name: "valid", content: ` @@ -392,10 +412,10 @@ body: - label: Option 2 of checkboxes required: false - label: Hidden Option 3 of checkboxes - hide_on_form: true + visible: [content] - label: Required but not submitted required: true - skip_submit: true + visible: [form] `, want: &api.IssueTemplate{ Name: "Name", @@ -470,8 +490,8 @@ body: "options": []any{ map[string]any{"label": "Option 1 of checkboxes", "required": true}, map[string]any{"label": "Option 2 of checkboxes", "required": false}, - map[string]any{"label": "Hidden Option 3 of checkboxes", "hide_on_form": true}, - map[string]any{"label": "Required but not submitted", "required": true, "skip_submit": true}, + map[string]any{"label": "Hidden Option 3 of checkboxes", "visible": []string{"content"}}, + map[string]any{"label": "Required but not submitted", "required": true, "visible": []string{"form"}}, }, }, Visible: []api.IssueFormFieldVisible{api.IssueFormFieldVisibleForm, api.IssueFormFieldVisibleContent}, @@ -716,9 +736,9 @@ body: required: false - label: Option 3 of checkboxes required: true - skip_submit: true + visible: [form] - label: Hidden Option of checkboxes - hide_on_form: true + visible: [content] `, values: map[string][]string{ "form-field-id3": {"Value of id3"}, From 201fb3aa2f7d3c293e6b29ef8c91a5f8adac3869 Mon Sep 17 00:00:00 2001 From: 6543 <6543@obermui.de> Date: Fri, 1 Mar 2024 19:34:45 +0100 Subject: [PATCH 26/32] handle checkboxes templates take1 --- templates/repo/issue/fields/checkboxes.tmpl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/repo/issue/fields/checkboxes.tmpl b/templates/repo/issue/fields/checkboxes.tmpl index e6900af8d3c8..8c1b8c4a03b6 100644 --- a/templates/repo/issue/fields/checkboxes.tmpl +++ b/templates/repo/issue/fields/checkboxes.tmpl @@ -2,7 +2,7 @@ {{template "repo/issue/fields/header" .}} {{range $i, $opt := .item.Attributes.options}}
-
+
From 7461a8baa8745f056626f9883b1b3fa6d97d3e49 Mon Sep 17 00:00:00 2001 From: "m.huber" Date: Fri, 1 Mar 2024 19:48:52 +0100 Subject: [PATCH 27/32] handle checkboxes templates take2 --- templates/repo/issue/fields/checkboxes.tmpl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/repo/issue/fields/checkboxes.tmpl b/templates/repo/issue/fields/checkboxes.tmpl index 8c1b8c4a03b6..b928b2be58cf 100644 --- a/templates/repo/issue/fields/checkboxes.tmpl +++ b/templates/repo/issue/fields/checkboxes.tmpl @@ -2,7 +2,7 @@ {{template "repo/issue/fields/header" .}} {{range $i, $opt := .item.Attributes.options}}
-
+
From e331c0eb226dad076bdad51d65688d146c76aa05 Mon Sep 17 00:00:00 2001 From: "m.huber" Date: Fri, 1 Mar 2024 20:09:11 +0100 Subject: [PATCH 28/32] fix lint --- modules/structs/issue.go | 11 +++++------ templates/swagger/v1_json.tmpl | 1 - 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/modules/structs/issue.go b/modules/structs/issue.go index cc213dc7a26b..16242d18ada5 100644 --- a/modules/structs/issue.go +++ b/modules/structs/issue.go @@ -142,12 +142,11 @@ const ( // IssueFormField represents a form field // swagger:model type IssueFormField struct { - Type IssueFormFieldType `json:"type" yaml:"type"` - ID string `json:"id" yaml:"id"` - Attributes map[string]any `json:"attributes" yaml:"attributes"` - Validations map[string]any `json:"validations" yaml:"validations"` - // default: [form,content] - Visible []IssueFormFieldVisible `json:"visible,omitempty"` + Type IssueFormFieldType `json:"type" yaml:"type"` + ID string `json:"id" yaml:"id"` + Attributes map[string]any `json:"attributes" yaml:"attributes"` + Validations map[string]any `json:"validations" yaml:"validations"` + Visible []IssueFormFieldVisible `json:"visible,omitempty"` } func (iff IssueFormField) VisibleOnForm() bool { diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl index e88fda7527bf..4d452e4b7f45 100644 --- a/templates/swagger/v1_json.tmpl +++ b/templates/swagger/v1_json.tmpl @@ -20626,7 +20626,6 @@ }, "visible": { "type": "array", - "default": "[form,content]", "items": { "$ref": "#/definitions/IssueFormFieldVisible" }, From edbc7ed1b9ab1a67dac9ddb220e2a12cc1ad04f2 Mon Sep 17 00:00:00 2001 From: 6543 <6543@obermui.de> Date: Mon, 4 Mar 2024 00:43:18 +0100 Subject: [PATCH 29/32] Update modules/issue/template/unmarshal.go Co-authored-by: delvh --- modules/issue/template/unmarshal.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/issue/template/unmarshal.go b/modules/issue/template/unmarshal.go index cc13b49b1329..0fc13d7ddfc4 100644 --- a/modules/issue/template/unmarshal.go +++ b/modules/issue/template/unmarshal.go @@ -132,7 +132,7 @@ func unmarshal(filename string, content []byte) (*api.IssueTemplate, error) { if v.ID == "" { v.ID = strconv.Itoa(i) } - // set default submit value + // set default visibility if v.Visible == nil { v.Visible = []api.IssueFormFieldVisible{api.IssueFormFieldVisibleForm} // markdown is not submitted by default From 26ea4649024d2d922cb35e9091b10a4cd496dd56 Mon Sep 17 00:00:00 2001 From: "m.huber" Date: Mon, 4 Mar 2024 00:50:53 +0100 Subject: [PATCH 30/32] apply suggested rename --- modules/issue/template/template.go | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/modules/issue/template/template.go b/modules/issue/template/template.go index d27051b81949..3be48b9edc04 100644 --- a/modules/issue/template/template.go +++ b/modules/issue/template/template.go @@ -178,12 +178,12 @@ func validateOptions(field *api.IssueFormField, idx int) error { return position.Errorf("'label' is required and should be a string") } - if visible, ok := opt["visible"]; ok { - visibleList, ok := visible.([]any) + if visibility, ok := opt["visible"]; ok { + visibilityList, ok := visibility.([]any) if !ok { return position.Errorf("'visible' should be list") } - for _, visibleType := range visibleList { + for _, visibleType := range visibilityList { visibleType, ok := visibleType.(string) if !ok || !(visibleType == "form" || visibleType == "content") { return position.Errorf("'visible' list can only contain strings of 'form' and 'content'") @@ -197,10 +197,10 @@ func validateOptions(field *api.IssueFormField, idx int) error { } // validate if hidden field is required - if visible, ok := opt["visible"]; ok { - visibleList, _ := visible.([]any) + if visibility, ok := opt["visible"]; ok { + visibilityList, _ := visibility.([]any) isVisible := false - for _, v := range visibleList { + for _, v := range visibilityList { if vv, _ := v.(string); vv == "form" { isVisible = true break From 4111e760a6eb2f4e37dc3162e10ddfeef6f9a420 Mon Sep 17 00:00:00 2001 From: "m.huber" Date: Mon, 4 Mar 2024 00:52:29 +0100 Subject: [PATCH 31/32] docs wording --- docs/content/usage/issue-pull-request-templates.en-us.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/usage/issue-pull-request-templates.en-us.md b/docs/content/usage/issue-pull-request-templates.en-us.md index c8b7ef285521..c5635fa793bd 100644 --- a/docs/content/usage/issue-pull-request-templates.en-us.md +++ b/docs/content/usage/issue-pull-request-templates.en-us.md @@ -136,7 +136,7 @@ body: attributes: value: | Thanks for taking the time to fill out this bug report! - # some markdown which will be visible only in the created issue + # some markdown that will only be visible once the issue has been created - type: markdown attributes: value: | From e726ce01d052e583ec2a24ed606edf4d77725316 Mon Sep 17 00:00:00 2001 From: "m.huber" Date: Mon, 4 Mar 2024 00:58:07 +0100 Subject: [PATCH 32/32] docs better wording --- .../usage/issue-pull-request-templates.en-us.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/content/usage/issue-pull-request-templates.en-us.md b/docs/content/usage/issue-pull-request-templates.en-us.md index c5635fa793bd..e203c0d379a6 100644 --- a/docs/content/usage/issue-pull-request-templates.en-us.md +++ b/docs/content/usage/issue-pull-request-templates.en-us.md @@ -292,11 +292,11 @@ Attributes: For each value in the options array, you can set the following keys. -| Key | Description | Required | Type | Default | Options | -|--------------|------------------------------------------------------------------------------------------------------------------------------------------------|----------|--------------|---------|---------| -| label | The identifier for the option, which is displayed in the form. Markdown is supported for bold or italic text formatting, and hyperlinks. | Required | String | - | - | -| required | Prevents form submission until element is completed. | Optional | Boolean | false | - | -| visible | Set visible to a specific checkbox. Valid options are "form" to render in only in the form, "content" to have it in the created issue and both | Optional | String array | false | - | +| Key | Description | Required | Type | Default | Options | +|--------------|------------------------------------------------------------------------------------------------------------------------------------------|----------|--------------|---------|---------| +| label | The identifier for the option, which is displayed in the form. Markdown is supported for bold or italic text formatting, and hyperlinks. | Required | String | - | - | +| required | Prevents form submission until element is completed. | Optional | Boolean | false | - | +| visible | Whether a specific checkbox appears in the form only, in the created issue only, or both. Valid options are "form" and "content". | Optional | String array | false | - | visible: Default is **[form, content]**