From b084b3e3f42839c8d285f795ffb682634f461228 Mon Sep 17 00:00:00 2001 From: Janos <86970079+janosdebugs@users.noreply.github.com> Date: Fri, 7 Jun 2024 15:06:17 +0200 Subject: [PATCH] Adding warnings about TRACE logs (#1709) Signed-off-by: Janos <86970079+janosdebugs@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug_report.yml | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 5a5c886bc3..a5f65e3f00 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -11,13 +11,13 @@ body: attributes: value: | # Thank you for opening an issue. - + The [OpenTofu](https://github.com/opentofu/opentofu) issue tracker is reserved for bug reports relating to the core OpenTofu CLI application and configuration language. - + ## Filing a bug report - + To fix problems, we need clear reproduction cases - we need to be able to see it happen locally. A reproduction case is ideally something any engineer can git-clone or copy-paste and run immediately, without inventing any details or context. - + * A short example can be directly copy-pasteable; longer examples should be in separate git repositories, especially if multiple files are needed * Please include all needed context. For example, if you figured out that an expression can cause a crash, put the expression in a variable definition or a resource * Set defaults on (or omit) any variables. The person reproducing it should not need to invent variable settings @@ -52,7 +52,13 @@ body: id: tf-debug attributes: label: Debug Output - description: Full debug output can be obtained by running OpenTofu with the environment variable `TF_LOG=trace`. Please create a GitHub Gist containing the debug output. Please do _not_ paste the debug output in the issue, since debug output is long. Debug output may contain sensitive information. Please review it before posting publicly. + description: | + Full debug output can be obtained by running OpenTofu with the environment variable `TF_LOG=trace`. + Please create a GitHub Gist containing the debug output. Please do _not_ paste the debug output in the issue, + since debug output is long. Debug output may contain sensitive information. + + **⚠ Warning!** Carefully inspect the `TRACE` level OpenTofu logs! They may contain sensitive credentials. + When in doubt, you can omit posting the logs and provide information later. placeholder: ...link to gist... value: validations: