|
3 | 3 | **This PR may be auto-merged in the future if not configured.** |
4 | 4 |
|
5 | 5 | If your team does not need the security scanner: |
6 | | -- Please **close this PR** and add a comment explaining why |
7 | | -- Consider adding a `.github/no-security-scanner` file to opt-out permanently |
| 6 | +- **Add a comment on this PR** explaining why your team is opting out |
| 7 | +- **Close this PR** to prevent auto-merge |
| 8 | +- **Add a `.github/no-security-scanner` file** to your repository to prevent future onboarding attempts |
8 | 9 |
|
9 | 10 | If you need the scanner but want to customize it: |
10 | 11 | - Complete the checklist below |
@@ -41,11 +42,50 @@ The finding will automatically be dismissed by pushing a commit that fixes the i |
41 | 42 |
|
42 | 43 | ## Configuration |
43 | 44 |
|
44 | | -The scanner auto-detects languages in your repository. If you need to customize settings (ignore falsely detected languages, add Java/Kotlin build commands), please review the `languages-config` section in the workflow file. |
| 45 | +### Language Configuration |
45 | 46 |
|
46 | | -For detailed configuration examples and options, please review the tool's [README](https://github.com/MetaMask/action-security-code-scanner/blob/main/README.md). |
| 47 | +The scanner auto-detects languages in your repository. If you need to customize language-specific settings, you can modify the `languages-config` section in the workflow file. |
47 | 48 |
|
48 | | -For any questions, please reach out to `@app-sec` in Slack. |
| 49 | +**Common use cases:** |
| 50 | + |
| 51 | +1. **Ignore falsely detected languages:** |
| 52 | + ```yaml |
| 53 | + languages-config: | |
| 54 | + [ |
| 55 | + { |
| 56 | + "language": "ruby", |
| 57 | + "ignore": true |
| 58 | + } |
| 59 | + ] |
| 60 | + ``` |
| 61 | +
|
| 62 | +2. **Configure Java/Kotlin builds:** |
| 63 | + ```yaml |
| 64 | + languages-config: | |
| 65 | + [ |
| 66 | + { |
| 67 | + "language": "java-kotlin", |
| 68 | + "build_mode": "manual", |
| 69 | + "build_command": "./gradlew build", |
| 70 | + "version": "21", |
| 71 | + "distribution": "temurin" |
| 72 | + } |
| 73 | + ] |
| 74 | + ``` |
| 75 | +
|
| 76 | +**Supported languages:** `javascript-typescript`, `python`, `java-kotlin`, `go`, `cpp`, `csharp`, `ruby` |
| 77 | + |
| 78 | +**Build modes:** `none`, `autobuild`, `manual` |
| 79 | + |
| 80 | +### Additional Configuration |
| 81 | + |
| 82 | +For more configuration options, please review the tool's [README](https://github.com/MetaMask/action-security-code-scanner/blob/main/README.md). |
| 83 | + |
| 84 | +Optional secrets that can be configured: |
| 85 | +- `SECURITY_SCAN_METRICS_TOKEN` - for metrics collection |
| 86 | +- `APPSEC_BOT_SLACK_WEBHOOK` - for Slack notifications |
| 87 | + |
| 88 | +For any additional questions, please reach out to `@app-sec` in Slack. |
49 | 89 |
|
50 | 90 | --- |
51 | 91 | 🤖 *This PR was automatically created by the MetaMask Security onboarding system* |
0 commit comments