From e01009346d982beaac14b31cf509bc8d2926237d Mon Sep 17 00:00:00 2001 From: Benjamin Gilbert Date: Sat, 4 Feb 2023 22:41:29 -0500 Subject: [PATCH 1/2] templates: format bug-report Ignition config as YAML Users often post Butane configs rather than Ignition configs, and JSON is upward-compatible with YAML, so cover our bases by calling it YAML. This prevents the user from having to manually add a code block. Also reword the description to avoid asking a question that the field can no longer hold an answer for. --- .github/ISSUE_TEMPLATE/bug-report.yml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index b83ff6e..c8759cf 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -57,7 +57,10 @@ body: id: bug-ignition attributes: label: Ignition config - description: The Butane config or Ignition config used to provision your system. Be sure to sanitize any private data. If not using Butane to generate your Ignition config, does the Ignition config pass validation using [ignition-validate](https://coreos.github.io/ignition/getting-started/#config-validation)? + description: The Butane config or Ignition config used to provision your system. Be sure to sanitize any private data. If not using Butane to generate your Ignition config, ensure the Ignition config passes validation using [ignition-validate](https://coreos.github.io/ignition/getting-started/#config-validation). + # Might be Butane YAML or Ignition JSON, which is upward-compatible + # with YAML + render: yaml validations: required: false From e19d799ab3e347cf6e3538d5a1168ae75a39053b Mon Sep 17 00:00:00 2001 From: Benjamin Gilbert Date: Mon, 6 Feb 2023 12:11:58 -0500 Subject: [PATCH 2/2] templates: reword Ignition config field to "Butane or Ignition config" We usually get Butane configs anyway. --- .github/ISSUE_TEMPLATE/bug-report.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index c8759cf..c0699a7 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -54,9 +54,9 @@ body: required: true - type: textarea - id: bug-ignition + id: bug-config attributes: - label: Ignition config + label: Butane or Ignition config description: The Butane config or Ignition config used to provision your system. Be sure to sanitize any private data. If not using Butane to generate your Ignition config, ensure the Ignition config passes validation using [ignition-validate](https://coreos.github.io/ignition/getting-started/#config-validation). # Might be Butane YAML or Ignition JSON, which is upward-compatible # with YAML