From 99c3eb5136fd162095f1b4c251561a6c0ca96eba Mon Sep 17 00:00:00 2001 From: Fernando Date: Mon, 12 Aug 2024 13:07:53 -0600 Subject: [PATCH 1/2] add Native Image new issue template --- .../1_1_native_image_run_time_bug_report.yml | 105 ++++++++++++++++++ ...1_2_native_image_build_time_bug_report.yml | 95 ++++++++++++++++ .../1_3_native_image_crash_report.yml | 59 ++++++++++ .../1_issues_native_image_error_report.md | 10 -- .../2_issues_native_image_other.md | 30 ----- ..._issues_truffle.md => 2_issues_truffle.md} | 2 +- .../{4_issues_tools.md => 3_issues_tools.md} | 2 +- .../{5_issues_llvm.md => 4_issues_llvm.md} | 0 .../{6_issues_other.md => 5_issues_other.md} | 0 9 files changed, 261 insertions(+), 42 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/1_1_native_image_run_time_bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/1_2_native_image_build_time_bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/1_3_native_image_crash_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/1_issues_native_image_error_report.md delete mode 100644 .github/ISSUE_TEMPLATE/2_issues_native_image_other.md rename .github/ISSUE_TEMPLATE/{3_issues_truffle.md => 2_issues_truffle.md} (97%) rename .github/ISSUE_TEMPLATE/{4_issues_tools.md => 3_issues_tools.md} (97%) rename .github/ISSUE_TEMPLATE/{5_issues_llvm.md => 4_issues_llvm.md} (100%) rename .github/ISSUE_TEMPLATE/{6_issues_other.md => 5_issues_other.md} (100%) diff --git a/.github/ISSUE_TEMPLATE/1_1_native_image_run_time_bug_report.yml b/.github/ISSUE_TEMPLATE/1_1_native_image_run_time_bug_report.yml new file mode 100644 index 000000000000..89cc6735419d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1_1_native_image_run_time_bug_report.yml @@ -0,0 +1,105 @@ +name: 🚨 Native Image Run-Time Issue Report +description: Report run-time issues specific to GraalVM's native image +title: "[Native Image] " +labels: ["native-image", "bug", "run-time"] + +body: + - type: markdown + attributes: + value: "For security vulnerabilities, please consult the [GraalVM security policy](https://github.com/oracle/graal/security/policy) and contact the security team directly." + + - type: textarea + id: describe_issue + attributes: + label: Describe the Issue + description: "Describe the run-time issue you are experiencing with GraalVM's native image. Provide a clear and concise description of what happened and what you were trying to achieve." + validations: + required: true + + - type: checkboxes + id: latest_version_check + attributes: + label: "Using the latest version of GraalVM can resolve many issues." + options: + - label: "I tried with the [latest version](https://www.graalvm.org/downloads/) of GraalVM." + validations: + required: true + + - type: textarea + id: graalvm_version + attributes: + label: GraalVM Version + description: "Provide the version of GraalVM used." + placeholder: "Output of `java -version` " + validations: + required: true + + - type: input + id: operating_system + attributes: + label: Operating System and Version + description: "Provide details of your operating system and version (e.g., output of `uname -a` or Windows version)." + placeholder: "OS details here" + validations: + required: true + + - type: checkboxes + id: throw_missing_registration_errors + attributes: + label: "Diagnostic Flag Confirmation" + description: "Check the box if you tried adding the -H:ThrowMissingRegistrationErrors= flag to the image build to catch metadata exceptions early." + options: + - label: "I tried the `-H:ThrowMissingRegistrationErrors=` flag." + validations: + required: true + + - type: textarea + id: runtime_command + attributes: + label: Run Command + description: "Provide the exact command you used to run the native image." + placeholder: "e.g., `./my-native-image ...`" + validations: + required: true + + - type: textarea + id: expected_behavior + attributes: + label: Expected Behavior + description: "What did you expect to happen when running the native image?" + validations: + required: true + + - type: textarea + id: actual_behavior + attributes: + label: Actual Behavior + description: "What actually happened during the run? Describe any errors or unexpected outcomes." + validations: + required: true + + - type: textarea + id: steps_to_reproduce + attributes: + label: Steps to Reproduce + description: "Provide a step-by-step description of how to reproduce the run-time issue. Include any specific commands, configurations, or code snippets.\nAdditionally, share a native image bundle using the flag --bundle-create. See more [here](https://www.graalvm.org/latest/reference-manual/native-image/overview/Bundles/)." + placeholder: "1. \n2. \n3." + validations: + required: true + + - type: textarea + id: additional_context + attributes: + label: Additional Context + description: "Provide any additional context or information that might help in diagnosing the issue, such as environmental variables, system settings, or external dependencies." + validations: + required: false + + - type: textarea + id: log_output + attributes: + label: Run-Time Log Output and Error Messages + description: "Include any relevant run-time log outputs or error messages. Attach files by selecting this field and then dragging and dropping them into the comment box below the issue form." + placeholder: "Paste run-time logs or error messages here" + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/1_2_native_image_build_time_bug_report.yml b/.github/ISSUE_TEMPLATE/1_2_native_image_build_time_bug_report.yml new file mode 100644 index 000000000000..2228aaeb509e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1_2_native_image_build_time_bug_report.yml @@ -0,0 +1,95 @@ +name: 🚨 Native Image Build-Time Issue Report +description: Report build-time issues specific to GraalVM's native image +title: "[Native Image] " +labels: ["native-image", "bug", "build-time"] + +body: + - type: markdown + attributes: + value: "For security vulnerabilities, please consult the [GraalVM security policy](https://github.com/oracle/graal/security/policy) and contact the security team directly." + + - type: textarea + id: describe_issue + attributes: + label: Describe the Issue + description: "Describe the build-time issue you are experiencing with GraalVM's native image. Provide a clear and concise description of what happened and what you were trying to achieve." + validations: + required: true + + - type: checkboxes + id: latest_version_check + attributes: + label: "Using the latest version of GraalVM can resolve many issues." + options: + - label: "I tried with the [latest version](https://www.graalvm.org/downloads/) of GraalVM." + validations: + required: true + + - type: textarea + id: graalvm_version + attributes: + label: GraalVM Version + description: "Provide the version of GraalVM used." + placeholder: "Output of `java -version` " + validations: + required: true + + - type: input + id: operating_system + attributes: + label: Operating System and Version + description: "Provide details of your operating system and version (e.g., output of `uname -a` or Windows version)." + placeholder: "OS details here" + validations: + required: true + + - type: textarea + id: build_command + attributes: + label: Build Command + description: "Provide the exact build command you used." + placeholder: "e.g., `native-image --no-fallback ...`" + validations: + required: true + + - type: textarea + id: expected_behavior + attributes: + label: Expected Behavior + description: "What did you expect to happen when building the native image?" + validations: + required: true + + - type: textarea + id: actual_behavior + attributes: + label: Actual Behavior + description: "What actually happened during the build? Describe any errors or unexpected outcomes." + validations: + required: true + + - type: textarea + id: steps_to_reproduce + attributes: + label: Steps to Reproduce + description: "Provide a step-by-step description of how to reproduce the build-time issue. Include any specific commands, configurations, or code snippets.\nAdditionally, you can share a native image bundle using the flag --bundle-create. See more [here](https://www.graalvm.org/latest/reference-manual/native-image/overview/Bundles/)." + placeholder: "1. \n2. \n3." + validations: + required: true + + - type: textarea + id: additional_context + attributes: + label: Additional Context + description: "Provide any additional context or information that might help in diagnosing the issue, such as environmental variables, system settings, or external dependencies." + validations: + required: false + + - type: textarea + id: log_output + attributes: + label: Build Log Output and Error Messages + description: "Include any relevant build log outputs or error messages. Attach files by selecting this field and then dragging and dropping them into the comment box below the issue form." + placeholder: "Paste build logs or error messages here" + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/1_3_native_image_crash_report.yml b/.github/ISSUE_TEMPLATE/1_3_native_image_crash_report.yml new file mode 100644 index 000000000000..931b89aa703a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1_3_native_image_crash_report.yml @@ -0,0 +1,59 @@ +name: 💥 Share Native Image Crash Report (svm_err_b_*.md) +description: Share a crash report for GraalVM's Native Image using the generated `svm_err_b_*.md` file +title: "[Native Image] Crash Report" +labels: ["native-image", "crash-report"] + +body: + - type: markdown + attributes: + value: | + For security vulnerabilities, please consult the [GraalVM security policy](https://github.com/oracle/graal/security/policy) and contact the security team directly. + + - type: textarea + id: describe_issue + attributes: + label: Describe the Issue + description: "Describe the error you encountered with GraalVM's Native Image. Provide a clear and concise description of what happened and what you were trying to achieve." + validations: + required: true + + - type: checkboxes + id: latest_version_check + attributes: + label: "Please confirm if you have tested with the latest available version." + description: "Using the latest version of GraalVM can resolve many issues." + options: + - label: "I tried with the latest version of GraalVM. [Latest GraalVM Version](https://www.graalvm.org/downloads/)" + validations: + required: true + + - type: textarea + id: error_report_file + attributes: + label: Share the `svm_err_b_*.md` File + description: "Share to the `svm_err_b_*.md` file generated by the error." + placeholder: "Attach the error file here." + validations: + required: true + + - type: textarea + id: additional_context + attributes: + label: Additional Context + description: "Provide any additional context or information that might help in diagnosing the issue, such as environmental variables, system settings, or external dependencies." + validations: + required: false + + - type: markdown + attributes: + value: | + ### How to Find and Share the `svm_err_b_*.md` File + + When a native image build fails fatally, GraalVM generates a detailed error report file with a name like `svm_err_b__.md`. This file contains valuable information for diagnosing the issue. + + Use -H:ErrorFile to adjust the path or filename. + + Once located, please attach this file to the issue report. You can also provide a link to the file if it is hosted in a shared location. + + + diff --git a/.github/ISSUE_TEMPLATE/1_issues_native_image_error_report.md b/.github/ISSUE_TEMPLATE/1_issues_native_image_error_report.md deleted file mode 100644 index 8d50c704d18c..000000000000 --- a/.github/ISSUE_TEMPLATE/1_issues_native_image_error_report.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -# This template is linked from https://graalvm.org/native-image/error-report -name: "\U0001F6A8 Share Native Image error report" -about: Share an error report from Native Image. To report a security vulnerability, please see below or the SECURITY.md file at the root of the repository. Do not open a GitHub issue. -labels: bug, native-image - ---- - -Replace this text with the error report (`svm_err_b_*.md`) generated by the Native Image build process. -Please make sure the report does not contain any sensitive information. diff --git a/.github/ISSUE_TEMPLATE/2_issues_native_image_other.md b/.github/ISSUE_TEMPLATE/2_issues_native_image_other.md deleted file mode 100644 index 643b96e201d8..000000000000 --- a/.github/ISSUE_TEMPLATE/2_issues_native_image_other.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -name: "\U0001F6A8 Other Native Image Issues" -about: File an issue for a problem with Native Image. To report a security vulnerability, please see below or the SECURITY.md file at the root of the repository. Do not open a GitHub issue. -title: '' -labels: bug, native-image -assignees: '' - ---- -**Describe the issue** -A clear and concise description of the issue. We recommend using the [latest snapshot builds](https://github.com/graalvm/graalvm-ce-dev-builds/releases) to replicate the issue as bugs are constantly being fixed in the master branch - -**Steps to reproduce the issue** -Please include both build steps as well as run steps -1. **[e.g.: git clone --depth 1 https://git.myrepo.com/projectone ]** -2. **[e.g.: mvn clean package]** - -**Describe GraalVM and your environment:** - - GraalVM version (latest snapshot builds can be found [here](https://github.com/graalvm/graalvm-ce-dev-builds/releases)), or commit id if built from source: **[e.g. EE 19.3, CE 20.0, CE 20.1.0-dev-20200304_0848]** - - JDK major version: **[e.g.:8]** - - OS: **[e.g. macOS Catalina]** - - Architecture: **[e.g.: AMD64]** - - -**More details** -Consider adding the `--native-image-info` and `--verbose` flags when building your native image and paste output below. - -Add any other information about the problem here. Especially important are stack traces or log output. Feel free to link to gists or to screenshots if necessary. -``` - PASTE YOUR LOG/STACK TRACE HERE -``` diff --git a/.github/ISSUE_TEMPLATE/3_issues_truffle.md b/.github/ISSUE_TEMPLATE/2_issues_truffle.md similarity index 97% rename from .github/ISSUE_TEMPLATE/3_issues_truffle.md rename to .github/ISSUE_TEMPLATE/2_issues_truffle.md index f4756a7e682a..70aa2dd1372a 100644 --- a/.github/ISSUE_TEMPLATE/3_issues_truffle.md +++ b/.github/ISSUE_TEMPLATE/2_issues_truffle.md @@ -1,5 +1,5 @@ --- -name: "\U0001F6A8 Truffle Issue Report" +name: "📦 Truffle Issue Report" about: Create an issue report for a issue with the Truffle API (Language and Tool implementation, Language interop) and Polyglot API title: '' labels: truffle diff --git a/.github/ISSUE_TEMPLATE/4_issues_tools.md b/.github/ISSUE_TEMPLATE/3_issues_tools.md similarity index 97% rename from .github/ISSUE_TEMPLATE/4_issues_tools.md rename to .github/ISSUE_TEMPLATE/3_issues_tools.md index 50cafef8cce3..6dfcc1763079 100644 --- a/.github/ISSUE_TEMPLATE/4_issues_tools.md +++ b/.github/ISSUE_TEMPLATE/3_issues_tools.md @@ -1,5 +1,5 @@ --- -name: "\U0001F6A8 Tools Issue Report" +name: "🛠️ Tools Issue Report" about: Create an issue report for a issue with the Truffle tools (CPUSampler, Coverage tool, etc.) title: '' labels: tools diff --git a/.github/ISSUE_TEMPLATE/5_issues_llvm.md b/.github/ISSUE_TEMPLATE/4_issues_llvm.md similarity index 100% rename from .github/ISSUE_TEMPLATE/5_issues_llvm.md rename to .github/ISSUE_TEMPLATE/4_issues_llvm.md diff --git a/.github/ISSUE_TEMPLATE/6_issues_other.md b/.github/ISSUE_TEMPLATE/5_issues_other.md similarity index 100% rename from .github/ISSUE_TEMPLATE/6_issues_other.md rename to .github/ISSUE_TEMPLATE/5_issues_other.md From b810efd7fb0d70d15b233db996f52255d4df4541 Mon Sep 17 00:00:00 2001 From: Fernando Date: Mon, 12 Aug 2024 13:37:58 -0600 Subject: [PATCH 2/2] Add updates in the crash report template --- .github/ISSUE_TEMPLATE/1_3_native_image_crash_report.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/1_3_native_image_crash_report.yml b/.github/ISSUE_TEMPLATE/1_3_native_image_crash_report.yml index 931b89aa703a..3b8b35ad5e7a 100644 --- a/.github/ISSUE_TEMPLATE/1_3_native_image_crash_report.yml +++ b/.github/ISSUE_TEMPLATE/1_3_native_image_crash_report.yml @@ -1,5 +1,5 @@ -name: 💥 Share Native Image Crash Report (svm_err_b_*.md) -description: Share a crash report for GraalVM's Native Image using the generated `svm_err_b_*.md` file +name: 💥 Share Native Image Build-Time Crash Report +description: Share a crash report for GraalVM Native Image using the generated `svm_err_b_*.md` file title: "[Native Image] Crash Report" labels: ["native-image", "crash-report"] @@ -13,7 +13,7 @@ body: id: describe_issue attributes: label: Describe the Issue - description: "Describe the error you encountered with GraalVM's Native Image. Provide a clear and concise description of what happened and what you were trying to achieve." + description: "Describe the error you encountered with GraalVM Native Image. Provide a clear and concise description of what happened and what you were trying to achieve." validations: required: true