Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Native Image New Issue Template #9481

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 105 additions & 0 deletions .github/ISSUE_TEMPLATE/1_1_native_image_run_time_bug_report.yml
Original file line number Diff line number Diff line change
@@ -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
95 changes: 95 additions & 0 deletions .github/ISSUE_TEMPLATE/1_2_native_image_build_time_bug_report.yml
Original file line number Diff line number Diff line change
@@ -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
59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/1_3_native_image_crash_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: 💥 Share Native Image Crash Report (svm_err_b_*.md)
fernando-valdez marked this conversation as resolved.
Show resolved Hide resolved
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."
fernando-valdez marked this conversation as resolved.
Show resolved Hide resolved
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_<timestamp>_<pid>.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.



10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/1_issues_native_image_error_report.md

This file was deleted.

30 changes: 0 additions & 30 deletions .github/ISSUE_TEMPLATE/2_issues_native_image_other.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Loading