From ecd69ed36ef0233b7197d1bc8d099bce4bd12bc6 Mon Sep 17 00:00:00 2001 From: Sviatoslav Sydorenko Date: Tue, 6 Apr 2021 17:46:21 +0200 Subject: [PATCH] Use `render` for code blocks in issue forms --- .github/ISSUE_TEMPLATE/bug_report.yml | 39 ++++++++++++------- .../ISSUE_TEMPLATE/documentation_report.yml | 32 ++++++++++----- 2 files changed, 48 insertions(+), 23 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 9ae169ed821..186a08f5842 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -48,13 +48,22 @@ body: attributes: label: Ansible Version description: >- - Paste verbatim output from `ansible --version` between - tripple backticks. + Paste verbatim output from `ansible --version` below, under + the prompt line. Please don't wrap it with tripple backticks. + render: console value: | - ```console (paste below) $ ansible --version - - ``` + placeholder: | + $ ansible --version + ansible [core 2.11.0b4.post0] (detached HEAD ref: refs/) last updated 2021/04/02 00:33:35 (GMT +200) + config file = None + configured module search path = ['~/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules'] + ansible python module location = ~/src/github/ansible/ansible/lib/ansible + ansible collection location = ~/.ansible/collections:/usr/share/ansible/collections + executable location = bin/ansible + python version = 3.9.0 (default, Oct 26 2020, 13:08:59) [GCC 10.2.0] + jinja version = 2.11.3 + libyaml = True validations: required: true @@ -62,12 +71,17 @@ body: attributes: label: Configuration description: >- - Paste verbatim output from `ansible-config dump --only-changed` between quotes. + Paste verbatim output from `ansible-config dump --only-changed` + below, under the prompt line. + Please don't wrap it with tripple backticks. + render: console value: | - ```console (paste below) $ ansible-config dump --only-changed - - ``` + placeholder: | + $ ansible-config dump --only-changed + DEFAULT_GATHERING(~/src/github/ansible/ansible/ansible.cfg) = smart + DEFAULT_HOST_LIST(~/src/github/ansible/ansible/ansible.cfg) = ['~/src/github/ansible/ansible/hosts'] + DEFAULT_VAULT_PASSWORD_FILE(~/src/github/ansible/ansible/ansible.cfg) = ~/src/github/ansible/ansible/vault/print-password.sh validations: required: true @@ -114,11 +128,8 @@ body: description: | Describe what actually happened. If possible run with extra verbosity (`-vvvv`). - Paste verbatim command output between quotes. - value: | - ```console (paste below) - - ``` + Paste verbatim command output and don't wrap it with tripple backticks. + render: console validations: required: true diff --git a/.github/ISSUE_TEMPLATE/documentation_report.yml b/.github/ISSUE_TEMPLATE/documentation_report.yml index 8a82bb106ac..fda01aaed97 100644 --- a/.github/ISSUE_TEMPLATE/documentation_report.yml +++ b/.github/ISSUE_TEMPLATE/documentation_report.yml @@ -51,13 +51,22 @@ body: attributes: label: Ansible Version description: >- - Paste verbatim output from `ansible --version` between - tripple backticks. + Paste verbatim output from `ansible --version` below, under + the prompt line. Please don't wrap it with tripple backticks. + render: console value: | - ```console (paste below) $ ansible --version - - ``` + placeholder: | + $ ansible --version + ansible [core 2.11.0b4.post0] (detached HEAD ref: refs/) last updated 2021/04/02 00:33:35 (GMT +200) + config file = None + configured module search path = ['~/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules'] + ansible python module location = ~/src/github/ansible/ansible/lib/ansible + ansible collection location = ~/.ansible/collections:/usr/share/ansible/collections + executable location = bin/ansible + python version = 3.9.0 (default, Oct 26 2020, 13:08:59) [GCC 10.2.0] + jinja version = 2.11.3 + libyaml = True validations: required: true @@ -65,12 +74,17 @@ body: attributes: label: Configuration description: >- - Paste verbatim output from `ansible-config dump --only-changed` between quotes. + Paste verbatim output from `ansible-config dump --only-changed` + below, under the prompt line. + Please don't wrap it with tripple backticks. + render: console value: | - ```console (paste below) $ ansible-config dump --only-changed - - ``` + placeholder: | + $ ansible-config dump --only-changed + DEFAULT_GATHERING(~/src/github/ansible/ansible/ansible.cfg) = smart + DEFAULT_HOST_LIST(~/src/github/ansible/ansible/ansible.cfg) = ['~/src/github/ansible/ansible/hosts'] + DEFAULT_VAULT_PASSWORD_FILE(~/src/github/ansible/ansible/ansible.cfg) = ~/src/github/ansible/ansible/vault/print-password.sh validations: required: true