Skip to content

Commit 4a91bba

Browse files
fernando-valdezfernando-valdez
committed
[GR-45874] Add Native Image New Issue Template
PullRequest: graal/18818
2 parents 13d0e2c + d21ea45 commit 4a91bba

9 files changed

+261
-42
lines changed

‎.github/ISSUE_TEMPLATE/1_1_native_image_run_time_bug_report.yml‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
name: 🚨 Native Image Run-Time Issue Report
2+
description: Report run-time issues specific to GraalVM's native image
3+
title: "[Native Image] "
4+
labels: ["native-image", "bug", "run-time"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: "For security vulnerabilities, please consult the [GraalVM security policy](https://github.com/oracle/graal/security/policy) and contact the security team directly."
10+
11+
- type: textarea
12+
id: describe_issue
13+
attributes:
14+
label: Describe the Issue
15+
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."
16+
validations:
17+
required: true
18+
19+
- type: checkboxes
20+
id: latest_version_check
21+
attributes:
22+
label: "Using the latest version of GraalVM can resolve many issues."
23+
options:
24+
- label: "I tried with the [latest version](https://www.graalvm.org/downloads/) of GraalVM."
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: graalvm_version
30+
attributes:
31+
label: GraalVM Version
32+
description: "Provide the version of GraalVM used."
33+
placeholder: "Output of `java -version` "
34+
validations:
35+
required: true
36+
37+
- type: input
38+
id: operating_system
39+
attributes:
40+
label: Operating System and Version
41+
description: "Provide details of your operating system and version (e.g., output of `uname -a` or Windows version)."
42+
placeholder: "OS details here"
43+
validations:
44+
required: true
45+
46+
- type: checkboxes
47+
id: throw_missing_registration_errors
48+
attributes:
49+
label: "Diagnostic Flag Confirmation"
50+
description: "Check the box if you tried adding the -H:ThrowMissingRegistrationErrors= flag to the image build to catch metadata exceptions early."
51+
options:
52+
- label: "I tried the `-H:ThrowMissingRegistrationErrors=` flag."
53+
validations:
54+
required: true
55+
56+
- type: textarea
57+
id: runtime_command
58+
attributes:
59+
label: Run Command
60+
description: "Provide the exact command you used to run the native image."
61+
placeholder: "e.g., `./my-native-image ...`"
62+
validations:
63+
required: true
64+
65+
- type: textarea
66+
id: expected_behavior
67+
attributes:
68+
label: Expected Behavior
69+
description: "What did you expect to happen when running the native image?"
70+
validations:
71+
required: true
72+
73+
- type: textarea
74+
id: actual_behavior
75+
attributes:
76+
label: Actual Behavior
77+
description: "What actually happened during the run? Describe any errors or unexpected outcomes."
78+
validations:
79+
required: true
80+
81+
- type: textarea
82+
id: steps_to_reproduce
83+
attributes:
84+
label: Steps to Reproduce
85+
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/)."
86+
placeholder: "1. \n2. \n3."
87+
validations:
88+
required: true
89+
90+
- type: textarea
91+
id: additional_context
92+
attributes:
93+
label: Additional Context
94+
description: "Provide any additional context or information that might help in diagnosing the issue, such as environmental variables, system settings, or external dependencies."
95+
validations:
96+
required: false
97+
98+
- type: textarea
99+
id: log_output
100+
attributes:
101+
label: Run-Time Log Output and Error Messages
102+
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."
103+
placeholder: "Paste run-time logs or error messages here"
104+
validations:
105+
required: false

‎.github/ISSUE_TEMPLATE/1_2_native_image_build_time_bug_report.yml‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
name: 🚨 Native Image Build-Time Issue Report
2+
description: Report build-time issues specific to GraalVM's native image
3+
title: "[Native Image] "
4+
labels: ["native-image", "bug", "build-time"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: "For security vulnerabilities, please consult the [GraalVM security policy](https://github.com/oracle/graal/security/policy) and contact the security team directly."
10+
11+
- type: textarea
12+
id: describe_issue
13+
attributes:
14+
label: Describe the Issue
15+
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."
16+
validations:
17+
required: true
18+
19+
- type: checkboxes
20+
id: latest_version_check
21+
attributes:
22+
label: "Using the latest version of GraalVM can resolve many issues."
23+
options:
24+
- label: "I tried with the [latest version](https://www.graalvm.org/downloads/) of GraalVM."
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: graalvm_version
30+
attributes:
31+
label: GraalVM Version
32+
description: "Provide the version of GraalVM used."
33+
placeholder: "Output of `java -version` "
34+
validations:
35+
required: true
36+
37+
- type: input
38+
id: operating_system
39+
attributes:
40+
label: Operating System and Version
41+
description: "Provide details of your operating system and version (e.g., output of `uname -a` or Windows version)."
42+
placeholder: "OS details here"
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
id: build_command
48+
attributes:
49+
label: Build Command
50+
description: "Provide the exact build command you used."
51+
placeholder: "e.g., `native-image --no-fallback ...`"
52+
validations:
53+
required: true
54+
55+
- type: textarea
56+
id: expected_behavior
57+
attributes:
58+
label: Expected Behavior
59+
description: "What did you expect to happen when building the native image?"
60+
validations:
61+
required: true
62+
63+
- type: textarea
64+
id: actual_behavior
65+
attributes:
66+
label: Actual Behavior
67+
description: "What actually happened during the build? Describe any errors or unexpected outcomes."
68+
validations:
69+
required: true
70+
71+
- type: textarea
72+
id: steps_to_reproduce
73+
attributes:
74+
label: Steps to Reproduce
75+
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/)."
76+
placeholder: "1. \n2. \n3."
77+
validations:
78+
required: true
79+
80+
- type: textarea
81+
id: additional_context
82+
attributes:
83+
label: Additional Context
84+
description: "Provide any additional context or information that might help in diagnosing the issue, such as environmental variables, system settings, or external dependencies."
85+
validations:
86+
required: false
87+
88+
- type: textarea
89+
id: log_output
90+
attributes:
91+
label: Build Log Output and Error Messages
92+
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."
93+
placeholder: "Paste build logs or error messages here"
94+
validations:
95+
required: false

‎.github/ISSUE_TEMPLATE/1_3_native_image_error_report.yml‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: 💥 Share Native Image Build-Time Error Report
2+
description: Share a error report for GraalVM Native Image using the generated `svm_err_b_*.md` file
3+
title: "[Native Image] Error Report"
4+
labels: ["native-image", "error-report"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
For security vulnerabilities, please consult the [GraalVM security policy](https://github.com/oracle/graal/security/policy) and contact the security team directly.
11+
12+
- type: textarea
13+
id: describe_issue
14+
attributes:
15+
label: Describe the Issue
16+
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."
17+
validations:
18+
required: true
19+
20+
- type: checkboxes
21+
id: latest_version_check
22+
attributes:
23+
label: "Please confirm if you have tested with the latest available version."
24+
description: "Using the latest version of GraalVM can resolve many issues."
25+
options:
26+
- label: "I tried with the latest version of GraalVM. [Latest GraalVM Version](https://www.graalvm.org/downloads/)"
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
id: error_report_file
32+
attributes:
33+
label: Share the `svm_err_b_*.md` File
34+
description: "Share to the `svm_err_b_*.md` file generated by the error."
35+
placeholder: "Attach the error file here."
36+
validations:
37+
required: true
38+
39+
- type: textarea
40+
id: additional_context
41+
attributes:
42+
label: Additional Context
43+
description: "Provide any additional context or information that might help in diagnosing the issue, such as environmental variables, system settings, or external dependencies."
44+
validations:
45+
required: false
46+
47+
- type: markdown
48+
attributes:
49+
value: |
50+
### How to Find and Share the `svm_err_b_*.md` File
51+
52+
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.
53+
54+
Use -H:ErrorFile to adjust the path or filename.
55+
56+
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.
57+
58+
59+

‎.github/ISSUE_TEMPLATE/1_issues_native_image_error_report.md‎

Lines changed: 0 additions & 10 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/2_issues_native_image_other.md‎

Lines changed: 0 additions & 30 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/3_issues_truffle.md‎ renamed to ‎.github/ISSUE_TEMPLATE/2_issues_truffle.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
name: "\U0001F6A8 Truffle Issue Report"
2+
name: "📦 Truffle Issue Report"
33
about: Create an issue report for a issue with the Truffle API (Language and Tool implementation, Language interop) and Polyglot API
44
title: ''
55
labels: truffle

‎.github/ISSUE_TEMPLATE/4_issues_tools.md‎ renamed to ‎.github/ISSUE_TEMPLATE/3_issues_tools.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
name: "\U0001F6A8 Tools Issue Report"
2+
name: "🛠️ Tools Issue Report"
33
about: Create an issue report for a issue with the Truffle tools (CPUSampler, Coverage tool, etc.)
44
title: ''
55
labels: tools

‎.github/ISSUE_TEMPLATE/5_issues_llvm.md‎ renamed to ‎.github/ISSUE_TEMPLATE/4_issues_llvm.md‎

File renamed without changes.

‎.github/ISSUE_TEMPLATE/6_issues_other.md‎ renamed to ‎.github/ISSUE_TEMPLATE/5_issues_other.md‎

File renamed without changes.

0 commit comments

Comments
 (0)