Skip to content

Commit 28d04ba

Browse files
Merge pull request #1840 from forcedotcom/release-5.2.0
RELEASE @W-18718646@: Conducting v5.2.0 release.
2 parents ea05a25 + 4d0c107 commit 28d04ba

35 files changed

+1665
-34034
lines changed

.github/ISSUE_TEMPLATE/0-code_analyzer_bug.yml

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,37 @@
1-
name: Report a Bug with a code-analyzer command
2-
description: Report an issue with a code-analyzer command.
1+
name: Report a Bug with the "code-analyzer" (v5) CLI Commands
2+
description: Report an issue with one of the commands contained in the "@salesforce/plugin-code-analyzer" Salesforce CLI plugin.
33
title: "[BUG][code-analyzer] <YOUR_TITLE_HERE>"
4-
labels: []
54
body:
65
- type: checkboxes
76
attributes:
87
label: Have you tried to resolve this issue yourself first?
98
description: |
10-
Oftentimes, you can resolve `code-analyzer` issues on your own. Follow these steps:
9+
You can often resolve `code-analyzer` issues on your own. Follow these steps:
1110
1. Read the error message.
12-
2. Read [Salesforce Code Analyzer](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/code-analyzer.html) documentation.
13-
3. Double-check the command that you ran. Ensure that items like file names, method names, and category names are correctly spelled and cased.
11+
2. Read the [Salesforce Code Analyzer](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/get-started.html) documentation.
12+
3. Double-check the command that you ran. Make sure that items like file names, method names, and tag names are correctly spelled and cased.
1413
4. Verify that your code is syntactically valid.
15-
5. Verify that the error is reproducible on another machine.
16-
6. Check open and closed [issues](https://github.com/forcedotcom/code-analyzer/issues) to see if your issue is already logged.
14+
5. Verify that the error is reproducible on another computer.
15+
6. Check the open and closed [issues](https://github.com/forcedotcom/code-analyzer/issues) to see if your issue is already logged.
1716
options:
18-
- label: I confirm I have gone through the above steps and still have an issue to report
17+
- label: I confirm I have gone through the above steps and still have an issue to report.
1918
required: true
2019
- type: textarea
2120
attributes:
2221
label: Bug Description
23-
description: Provide a clear and concise description of what the bug is and include the exact command that you ran.
22+
description: Provide a clear and concise overview of the bug.
2423
validations:
2524
required: true
2625
- type: textarea
2726
attributes:
2827
label: Output / Logs
29-
description: Attach any output or logs here
28+
description: Attach any output or logs here.
3029
placeholder: |
31-
Add log output here or drag files here.
30+
Add log output or drag files here.
3231
- type: textarea
3332
attributes:
3433
label: Steps To Reproduce
35-
description: List out the steps that you used to reproduce the bug behavior. Be as specific and clear as possible.
34+
description: List the steps that you used to reproduce the bug behavior. Be as specific and clear as possible. If possible, ensure the steps are reproducible on another machine and attach any files that demonstrate the issue.
3635
placeholder: |
3736
1. I first do ...
3837
2. Then I do ...
@@ -49,34 +48,34 @@ body:
4948
attributes:
5049
label: Operating System
5150
description: |
52-
What is your machine's operating system?
51+
What's your computer's operating system?
5352
placeholder: |
54-
Example: MacOS Sonoma 14.4.1
53+
Example: macOS Sonoma 14.4.1
5554
validations:
5655
required: true
5756
- type: input
5857
attributes:
5958
label: Salesforce CLI Version
6059
description: |
61-
What do you get from the command "sf --version"?
60+
What do you get when you run the "sf --version" command?
6261
placeholder: |
63-
Example: @salesforce/cli/2.40.7 darwin-arm64 node-v20.12.2
62+
Example: @salesforce/cli/2.90.4 darwin-x64 node-v22.15.0
6463
validations:
6564
required: true
6665
- type: input
6766
attributes:
6867
label: Code Analyzer Plugin (code-analyzer) Version
6968
description: |
70-
What do you get from the command "sf plugins"?
69+
What do you get when you run the "sf plugins" command?
7170
placeholder: |
72-
Example: code-analyzer 5.0.0
71+
Example: code-analyzer 5.0.0 (5.0.0)
7372
validations:
7473
required: true
7574
- type: input
7675
attributes:
7776
label: Node Version
7877
description: |
79-
What do you get from the command "node --version"?
78+
What do you get when you run the "node --version" command?
8079
placeholder: |
8180
Example: v23.4.0
8281
validations:
@@ -85,7 +84,7 @@ body:
8584
attributes:
8685
label: Java Version
8786
description: |
88-
What do you get from the command "java -version"?
87+
What do you get when you run the "java -version" command?
8988
placeholder: |
9089
Example: openjdk version "11.0.17.0.1" 2022-10-18 LTS
9190
validations:
@@ -94,15 +93,15 @@ body:
9493
attributes:
9594
label: Python Version
9695
description: |
97-
What do you get from the command "python --version"?
96+
What do you get when you run the "python --version" command?
9897
placeholder: |
9998
Example: Python 3.11.8
10099
validations:
101100
required: false
102101
- type: textarea
103102
attributes:
104103
label: Additional Context (Screenshots, Files, etc)
105-
description: Add any other context about the problem.
104+
description: Add any other context about your problem.
106105
placeholder: |
107106
Drag any files or screenshots you have here.
108107
- type: textarea

.github/ISSUE_TEMPLATE/1-scanner_bug.yml

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,37 @@
1-
name: Report a Bug with a scanner command (v4)
2-
description: Report an issue with a scanner command.
1+
name: Report a Bug with the "scanner" (v4) CLI Commands
2+
description: Report an issue with one of the commands contained in the "@salesforce/sfdx-scanner" Salesforce CLI plugin.
33
title: "[BUG][scanner] <YOUR_TITLE_HERE>"
4-
labels: []
54
body:
65
- type: checkboxes
76
attributes:
87
label: Have you tried to resolve this issue yourself first?
98
description: |
10-
Oftentimes, you can resolve `scanner` issues on your own. Follow these steps:
9+
You can often resolve `scanner` issues on your own. Follow these steps:
1110
1. Read the error message.
12-
2. Read [Salesforce Code Analyzer](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/overview) documentation.
13-
3. Double-check the command that you ran. Ensure that items like file names, method names, and category names are correctly spelled and cased.
11+
2. Read the [Salesforce Code Analyzer v4](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/code-analyzer-3x.html) documentation.
12+
3. Double-check the command that you ran. Make sure that items like file names, method names, and category names are correctly spelled and cased.
1413
4. Verify that your code is syntactically valid.
15-
5. Verify that the error is reproducible on another machine.
14+
5. Verify that the error is reproducible on another computer.
1615
6. Check open and closed [issues](https://github.com/forcedotcom/code-analyzer/issues) to see if your issue is already logged.
1716
options:
18-
- label: I confirm I have gone through the above steps and still have an issue to report
17+
- label: I confirm I have gone through the above steps and still have an issue to report.
1918
required: true
2019
- type: textarea
2120
attributes:
2221
label: Bug Description
23-
description: Provide a clear and concise description of what the bug is and include the exact command that you ran.
22+
description: Provide a clear and concise overview of the bug.
2423
validations:
2524
required: true
2625
- type: textarea
2726
attributes:
2827
label: Output / Logs
29-
description: Attach any output or logs here
28+
description: Attach any output or logs here.
3029
placeholder: |
31-
Add log output here or drag files here.
30+
Add log output or drag files here.
3231
- type: textarea
3332
attributes:
3433
label: Steps To Reproduce
35-
description: List out the steps that you used to reproduce the bug behavior. Be as specific and clear as possible.
34+
description: List the steps that you used to reproduce the bug behavior. Be as specific and clear as possible. If possible, ensure the steps are reproducible on another machine and attach any files that demonstrate the issue.
3635
placeholder: |
3736
1. I first do ...
3837
2. Then I do ...
@@ -49,34 +48,34 @@ body:
4948
attributes:
5049
label: Operating System
5150
description: |
52-
What is your machine's operating system?
51+
What is your computer's operating system?
5352
placeholder: |
54-
Example: MacOS Sonoma 14.4.1
53+
Example: macOS Sonoma 14.4.1
5554
validations:
5655
required: true
5756
- type: input
5857
attributes:
5958
label: Salesforce CLI Version
6059
description: |
61-
What do you get from the command "sf --version"?
60+
What do you get when you run the "sf --version" command?
6261
placeholder: |
63-
Example: @salesforce/cli/2.40.7 darwin-arm64 node-v20.12.2
62+
Example: @salesforce/cli/2.90.4 darwin-x64 node-v22.15.0
6463
validations:
6564
required: true
6665
- type: input
6766
attributes:
6867
label: Scanner Plugin Version
6968
description: |
70-
What do you get from the command "sf plugins"?
69+
What do you get when you run the "sf plugins" command?
7170
placeholder: |
72-
Example: @salesforce/sfdx-scanner/4.10.0
71+
Example: @salesforce/sfdx-scanner 4.12.0 (4.12.0)
7372
validations:
7473
required: true
7574
- type: input
7675
attributes:
7776
label: Node Version
7877
description: |
79-
What do you get from the command "node --version"?
78+
What do you get when you run the "node --version" command?
8079
placeholder: |
8180
Example: v23.4.0
8281
validations:
@@ -85,7 +84,7 @@ body:
8584
attributes:
8685
label: Java Version
8786
description: |
88-
What do you get from the command "java -version"?
87+
What do you get when you run the "java -version" command?
8988
placeholder: |
9089
Example: openjdk version "11.0.17.0.1" 2022-10-18 LTS
9190
validations:
@@ -111,4 +110,4 @@ body:
111110
- Critical
112111
default: 0
113112
validations:
114-
required: true
113+
required: true
Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
name: Report a Bug with the "Salesforce Code Analyzer" VS Code Extension
2+
description: Report an issue that's with the VS Code extension but not with the CLI commands.
3+
title: "[BUG][vscode-extension] <YOUR_TITLE_HERE>"
4+
body:
5+
- type: checkboxes
6+
attributes:
7+
label: Have you tried to resolve this issue yourself first?
8+
description: |
9+
You can often resolve these issues on your own. Follow these steps:
10+
1. Read the error message.
11+
2. Read the [Salesforce Code Analyzer VS Code Extension](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/analyze-vscode.html) documentation.
12+
3. Double-check the VS Code extension feature you used. Make sure that items like file names, method names, and category names are correctly spelled and cased.
13+
4. Verify that you can't reproduce the issue using the same Salesforce CLI command. Use the "Developer: Set Log Level" command from the Command Palette to set the log levels to 'DEBUG', and then the "Output" panel will display the code-analyzer command.
14+
5. Verify that your code is syntactically valid.
15+
6. Verify that the error is reproducible on another computer.
16+
7. Check open and closed [issues](https://github.com/forcedotcom/code-analyzer/issues) to see if your issue is already logged.
17+
options:
18+
- label: I confirm I have gone through the above steps and still have an issue to report.
19+
required: true
20+
- type: textarea
21+
attributes:
22+
label: Bug Description
23+
description: Provide a clear and concise overview of the bug.
24+
validations:
25+
required: true
26+
- type: textarea
27+
attributes:
28+
label: Output / Logs
29+
description: Attach any output or logs here.
30+
placeholder: |
31+
Add log output or drag files here.
32+
- type: textarea
33+
attributes:
34+
label: Steps To Reproduce
35+
description: List the steps that you used to reproduce the bug behavior. Be as specific and clear as possible. If possible, ensure the steps are reproducible on another machine and attach any files that demonstrate the issue.
36+
placeholder: |
37+
1. I first do ...
38+
2. Then I do ...
39+
3. Lastly, I do ...
40+
validations:
41+
required: true
42+
- type: textarea
43+
attributes:
44+
label: Expected Behavior
45+
description: Provide a clear and concise description of what you expected to happen.
46+
validations:
47+
required: true
48+
- type: input
49+
attributes:
50+
label: Operating System
51+
description: |
52+
What is your computer's operating system?
53+
placeholder: |
54+
Example: macOS Sonoma 14.4.1
55+
validations:
56+
required: true
57+
- type: input
58+
attributes:
59+
label: Visual Studio Code Version
60+
description: |
61+
What version do you see when you click "Code > About Visual Studio Code"?
62+
placeholder: |
63+
Example: Version: 1.89.1 (Universal)
64+
validations:
65+
required: true
66+
- type: input
67+
attributes:
68+
label: Salesforce CLI Version
69+
description: |
70+
What do you get when you run the "sf --version" command in the terminal?
71+
placeholder: |
72+
Example: @salesforce/cli/2.90.4 darwin-x64 node-v22.15.0
73+
validations:
74+
required: true
75+
- type: dropdown
76+
attributes:
77+
label: Using v4
78+
description: "Are you using Code Analyzer v4? (Is the setting 'Code Analyzer: Use v4 (Deprecated)' checked?)"
79+
options:
80+
- ""
81+
- "No"
82+
- "Yes"
83+
- "Not sure"
84+
validations:
85+
required: true
86+
- type: input
87+
attributes:
88+
label: Code Analyzer CLI Plugin Version
89+
description: |
90+
What do you get when you run the "sf plugins" command in the terminal?
91+
placeholder: |
92+
code-analyzer 5.0.0; or if using v4: @salesforce/sfdx-scanner 4.12.0
93+
validations:
94+
required: false
95+
- type: input
96+
attributes:
97+
label: Node Version
98+
description: |
99+
What do you get when you run the "node --version" command in the terminal?
100+
placeholder: |
101+
Example: v23.4.0
102+
validations:
103+
required: false
104+
- type: input
105+
attributes:
106+
label: Java Version
107+
description: |
108+
What do you get when you run the "java -version" command in the terminal?
109+
placeholder: |
110+
Example: openjdk version "11.0.17.0.1" 2022-10-18 LTS
111+
validations:
112+
required: false
113+
- type: input
114+
attributes:
115+
label: Python Version
116+
description: |
117+
What do you get when you run the "python --version" command in the terminal?
118+
placeholder: |
119+
Example: Python 3.11.8
120+
validations:
121+
required: false
122+
- type: textarea
123+
attributes:
124+
label: Additional Context (Screenshots, Files, etc)
125+
description: Add any other context about the problem.
126+
placeholder: |
127+
Drag any files or screenshots you have here.
128+
- type: textarea
129+
attributes:
130+
label: Workaround
131+
description: What ways have you found to sidestep the problem? If you haven't found a workaround, what have you tried so far?
132+
- type: dropdown
133+
attributes:
134+
label: Urgency
135+
description: What is the severity of the problem?
136+
options:
137+
- Low
138+
- Moderate
139+
- High
140+
- Critical
141+
default: 0
142+
validations:
143+
required: true

0 commit comments

Comments
 (0)