Skip to content

Commit c55cbc6

Browse files
jfeingold35jfeingold35
authored
Merge pull request #1231 from forcedotcom/dev
RELEASE: @W-14381328@: Merging dev to release for v3.18.0
2 parents 2c34ba5 + 13bb275 commit c55cbc6

37 files changed

+3731
-547
lines changed

‎.github/ISSUE_TEMPLATE/0scanner_run_bug.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
name: Report a Bug with scanner:run
3+
about: Report an issue with the scanner:run command.
4+
title: "[BUG]"
5+
labels: ''
6+
assignees: ''
7+
---
8+
<!--
9+
### Try These Steps to Resolve Issues with `scanner:run`
10+
11+
Oftentimes, you can resolve `scanner:run` issues on your own. Follow these steps.
12+
13+
1. Read the error message.
14+
2. Read [Salesforce Code Analyzer](https://forcedotcom.github.io/sfdx-scanner/) documentation.
15+
3. Double-check the command that you ran. Ensure that items like file names, method names, and category names are correctly spelled and cased.
16+
4. Verify that your code is syntactically valid.
17+
5. Verify that the error is reproducible on another machine.
18+
6. Attempt to reproduce the error by running against that engine directly instead of via the Code Analyzer. If you can reproduce the error, create an issue on that engine's repo instead of on Code Analyzer's repo.
19+
7. Check open and closed [issues](https://github.com/forcedotcom/sfdx-scanner/issues) to see if your issue is already logged.
20+
21+
### Prepare for an AppExchange Security Review
22+
23+
If you're listing a managed package on AppExchange, prepare for the security review by following the instructions in the [Scan Your Solution with Salesforce Code Analyzer](https://developer.salesforce.com/docs/atlas.en-us.packagingGuide.meta/packagingGuide/security_review_code_analyzer_scan.htm) section of the ISVforce Guide.
24+
25+
### Log a `scanner:run` Issue
26+
If you're still having trouble after following the troubleshooting steps and checking that there's no existing issue that covers your situation, log a new `scanner:run` issue.
27+
28+
1. Fill out the `scanner:run` Issue Template.
29+
2. Attach your code with your issue.
30+
3. If you can't publicly share the code that causes the issue, reproduce it in code that you can publicly share. Attach this substitute code to your issue.
31+
4. Give your issue a clear and specific title. Example: "InternalExecutionError when scanning XYZ code".
32+
-->
33+
### `scanner:run` Issue Template
34+
35+
Fill out this template to submit your Code Analyzer issue.
36+
37+
**Description**:
38+
<!--Provide a clear and concise description of what the bug is.-->
39+
40+
**Documentation**:
41+
<!--Attach any documentation, such as a clean log.-->
42+
43+
**Steps To Reproduce**:
44+
<!--List out the steps that you used to reproduce the bug behavior. Be as specific and clear as possible.-->
45+
46+
**Expected Behavior**:
47+
<!--Provide a clear and concise description of what you expected to happen.-->
48+
49+
**Screenshots**:
50+
<!--If applicable, add screenshots to help explain your problem.-->
51+
52+
**Desktop**:
53+
<!--
54+
Provide these details:
55+
- Operating System. Example: Ventura 13.5
56+
- Code Analyzer version. Example: v3.16.0
57+
- Salesforce CLI version. Example: @salesforce/cli/2.0.2
58+
-->
59+
60+
**Additional Context**:
61+
<!--Add any other context about the problem.-->
62+
63+
**Workaround**:
64+
<!--What ways have you found to sidestep the problem? If you haven't found a workaround, what have you tried so far?-->
65+
66+
**Urgency**:
67+
<!--What is the severity of the problem?-->

‎.github/ISSUE_TEMPLATE/1scanner_run_dfa_bug.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
name: Report a Bug with scanner:run:dfa
3+
about: Report an issue with the scanner:run:dfa command.
4+
title: "[BUG]"
5+
labels: ''
6+
assignees: ''
7+
---
8+
<!--
9+
### Try These Steps to Resolve Issues with `scanner:run:dfa`
10+
11+
Oftentimes, you can resolve `scanner:run:dfa` issues on your own. Follow these steps.
12+
13+
1. Read the error message.
14+
2. Read [Salesforce Graph Engine](https://forcedotcom.github.io/sfdx-scanner/en/v3.x/salesforce-graph-engine/introduction/) documentation.
15+
3. Read our guide for [troubleshooting Graph Engine errors](https://forcedotcom.github.io/sfdx-scanner/en/v3.x/troubleshooting/#issues-using-salesforce-graph-engine).
16+
4. Read our guidelines to resolve [LimitReached errors](https://forcedotcom.github.io/sfdx-scanner/en/v3.x/salesforce-graph-engine/working-with-sfge/#understand-limitreached-errors) and [path evaluation timeouts](https://forcedotcom.github.io/sfdx-scanner/en/v3.x/troubleshooting/#issues-using-salesforce-graph-engine).
17+
5. Read our [Guide to Writing Graph Engine-Friendly Code](https://forcedotcom.github.io/sfdx-scanner/en/v3.x/salesforce-graph-engine/graph-engine-recommendations/).
18+
6. Double-check the command that you entered. Ensure that items like file names, method names, and category names are correctly spelled and cased.
19+
7. Verify that your code is syntactically valid.
20+
8. Verify that the error is reproducible on another machine.
21+
9. Check open and closed [issues](https://github.com/forcedotcom/sfdx-scanner/issues) to see if your issue is already logged.
22+
10. If there's no existing issue that covers your situation, log a new issue.
23+
24+
### Prepare for an AppExchange Security Review
25+
26+
If you're listing a managed package on AppExchange, prepare for the security review by following the instructions in the [Scan Your Solution with Salesforce Code Analyzer](https://developer.salesforce.com/docs/atlas.en-us.packagingGuide.meta/packagingGuide/security_review_code_analyzer_scan.htm) section of the ISVforce Guide.
27+
28+
**Note: In your scan report, if you see an InternalExecutionError or a LimitReached error, you can still submit for AppExchange security review. These errors aren't blockers.**
29+
30+
### Log a `scanner:run:dfa` Issue
31+
If you're still having trouble after following the troubleshooting steps and checking that there's no existing issue that covers your situation, log a new `scanner:run:dfa` issue.
32+
33+
1. Fill out the `scanner:run:dfa` Issue Template.
34+
2. Attach your code with your issue.
35+
3. If you can't publicly share the code that causes the issue, reproduce it in code that you can publicly share. Attach this substitute code to your issue.
36+
4. Give your issue a clear and specific title. Example: InternalExecutionError when scanning XYZ code.
37+
-->
38+
### `scanner:run:dfa` Issue Template
39+
40+
Fill out this template to submit your Code Analyzer issue.
41+
42+
**Description:**
43+
<!--Provide a clear and concise description of what the bug is.-->
44+
45+
**Documentation:**
46+
<!--Attach a clean log, which can be found in `~/.sfdx-scanner/sfge.log`. List the affected file. If the error message mentions a specific graph vertex, check its DefiningType and BeginLine properties and include the code at that line.-->
47+
48+
**Steps To Reproduce:**
49+
<!--List out the steps that you used to reproduce the bug behavior. Be as specific and clear as possible.-->
50+
51+
**Expected Behavior:**
52+
<!--Provide a clear and concise description of what you expected to happen.-->
53+
54+
**Screenshots:**
55+
<!--If applicable, add screenshots to help explain your problem.-->
56+
57+
**Desktop:**
58+
<!--
59+
Provide these details:
60+
- Operating System. Example: Ventura 13.5
61+
- Code Analyzer version. Example: v3.16.0
62+
- Salesforce CLI version. Example: @salesforce/cli/2.0.2
63+
-->
64+
65+
**Additional Context:**
66+
<!--Add any other context about the problem.-->
67+
68+
**Workaround:**
69+
<!--What ways have you found to sidestep the problem? If you haven't found a workaround, what have you tried so far?-->
70+
71+
**Urgency:**
72+
<!--What is the severity of the problem?-->

‎.github/ISSUE_TEMPLATE/2scanner_run_false_result.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
name: Report a scanner:run False Result
3+
about: Report false results in scanner:run scan reports. If you’re submitting your managed package for AppExchange security review, include documentation of your false results with your submission.
4+
title: "[False Result]"
5+
labels: ''
6+
assignees: ''
7+
---
8+
### Salesforce Code Analyzer False Results Template
9+
10+
**Description:**
11+
<!--Provide a clear and concise description of what the bug is.-->
12+
13+
**Documentation:**
14+
<!--Attach a clean log, if available.-->
15+
16+
**False Results Report:**
17+
<!--Explain why you believe this error is a false result.-->
18+
19+
**Steps To Reproduce:**
20+
<!--List out the steps that you used to reproduce the bug behavior. Be as specific and clear as possible.-->
21+
22+
**Expected Behavior:**
23+
<!--Provide a clear and concise description of what you expected to happen.-->
24+
25+
**Screenshots:**
26+
<!--If applicable, add screenshots to help explain your problem.-->
27+
28+
**Desktop:**
29+
<!--
30+
Provide these details:
31+
- Operating System. Example: Ventura 13.5
32+
- Code Analyzer version. Example: v3.16.0
33+
- Salesforce CLI version. Example: @salesforce/cli/2.0.2
34+
-->
35+
36+
**Additional Context:**
37+
<!--Add any other context about the problem. Provide any specific code or configuration details required to reproduce the problem.-->
38+
39+
**Workaround:**
40+
<!--What ways have you found to sidestep the problem? If you haven't found a workaround, what have you tried so far?-->
41+
42+
**Urgency:**
43+
<!--What is the severity of the problem?-->

‎.github/ISSUE_TEMPLATE/3scanner_run_dfa_false_result.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
name: Report a scanner:run:dfa False Result
3+
about: Report false results returned in scanner:run:dfa scan reports. If you’re submitting for AppExchange security review, include documentation of your false results with your submission.
4+
title: "[False Result]"
5+
labels: ''
6+
assignees: ''
7+
---
8+
### `scanner:run:dfa` False Positives Template
9+
10+
**Description:**
11+
<!--Provide a clear and concise description of what the bug is.-->
12+
13+
**Documentation:**
14+
<!--Attach a clean log, which you can find in `~/.sfdx-scanner/sfge.log`, list the affected files and lines for the source and sink vertices.-->
15+
16+
**False results Report:**
17+
<!--Explain why you believe this error is a false result.-->
18+
19+
**Steps To Reproduce:**
20+
<!--List out the steps that you used to reproduce the bug behavior. Be as specific and clear as possible.-->
21+
22+
**Expected Behavior:**
23+
<!--Provide a clear and concise description of what you expected to happen.-->
24+
25+
**Screenshots:**
26+
<!--If applicable, add screenshots to help explain your problem.-->
27+
28+
**Desktop:**
29+
<!--
30+
Provide these details:
31+
- Operating System. Example: Ventura 13.5
32+
- Code Analyzer version. Example: v3.16.0
33+
- Salesforce CLI version. Example: @salesforce/cli/2.0.2
34+
-->
35+
36+
**Additional Context:**
37+
<!--Add any other context about the problem. Provide any specific code or configuration details required to reproduce the problem.-->
38+
39+
**Workaround:**
40+
<!--What ways have you found to sidestep the problem? If you haven't found a workaround, what have you tried so far?-->
41+
42+
**Urgency:**
43+
<!--What is the severity of the problem?-->

‎.github/ISSUE_TEMPLATE/4feature_request.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Request a New Feature
3+
about: Request a new Salesforce Code Analyzer feature. Suggest a new rule or an additional engine.
4+
title: "[Feature Request]"
5+
labels: USER STORY
6+
assignees: ''
7+
---
8+
9+
**Is your feature request related to an issue that you encountered with Salesforce Code Analyzer?**
10+
<!--Provide a clear and concise description of what the problem is. Example: When I run `scanner:run:describe`, I want to see a sorted list of commands.
11+
12+
**Describe the solution that you want:**
13+
<!--Describe the clear and concise description of the result that you expect from your feature request.-->
14+
15+
**Describe alternatives that you've considered:**
16+
<!--Describe any alternative solutions or features you've considered.-->
17+
18+
**Additional Context:**
19+
<!--Give us any other context or screenshots about your feature request.-->
20+
21+
**Workaround:**
22+
<!--Are there any current Code Analyzer or Graph Engine existing capabilities that match or are similar to your feature request?-->
23+
24+
**Urgency:**
25+
<!--If we can implement your feature, how soon would you like to use this feature? Choose from: Nice to have, Highly Beneficial, or Can't Live Without It.-->
26+

‎.github/ISSUE_TEMPLATE/bug_report.md‎

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

‎.github/ISSUE_TEMPLATE/business-stopping-bug.md‎

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

‎.github/ISSUE_TEMPLATE/feature_request.md‎

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

‎.github/workflows/run-tests.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ jobs:
257257
- run: mkdir test-results
258258
- name: Self-evaluation
259259
id: self-eval
260-
run: bin/run scanner:run --target ./src --format junit --outfile ./test-results/src.xml --severity-threshold 3
260+
run: bin/run.js scanner:run --target ./src --format junit --outfile ./test-results/src.xml --severity-threshold 3
261261
# TODO: In the future, we could replace this step with a JS-based one that uses `core.setFailed()` to set a failure
262262
# message in the annotations.
263263
- name: Log results

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,9 @@ build
147147
.project
148148
.settings
149149

150+
# OCLIF lockfile auto-generated during publishing
151+
oclif.lock
152+
150153
pmd-cataloger/bin
151154

152155
sfge*.log.gz

0 commit comments

Comments
 (0)