You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<palign="center">Scans for unsafe contexts, hardcoded IDs, and other issues to optimize your Flows.</p>
7
7
8
8

9
9
10
-
_[](https://github.com/marketplace/actions/run-flow-scanner) - For more information on the default rules and configurations available, please review the [Flow Scanner Documentation](https://flow-scanner.github.io/lightning-flow-scanner-core/)._
10
+
_[](https://github.com/marketplace/actions/run-flow-scanner) - For more info on the rules and configurations, please review the [Scanner Documentation](https://flow-scanner.github.io/lightning-flow-scanner-core/)._
11
11
12
12
## Usage
13
13
@@ -38,19 +38,17 @@ Also ensure the following:
38
38
- Workflows have read and write permissions in the repository.
39
39
- Allow GitHub Actions to create and approve pull requests.
40
40
41
-
### Automatically Runs On Pull Requests:
41
+
### A) Automatically Runs On Pull Requests:
42
42
43
43
`on:pull_request`will trigger Flow Scanner to scan changed flow files every time a pull request is opened.
44
44
45
-
### Or Run It Manually:
45
+
### B) Or Run It Manually:
46
46
47
47
`on:workflow_dispatch` allows you to run the action on all Flows manually, by following these steps:
48
48
1. Navigate to the "Actions" tab of your GitHub repository.
49
49
2. Click on "Run Flow Scanner" in the list of available workflows.
50
50
3. Press the "Run workflow" button to trigger the action.
51
51
52
-
---
53
-
54
52
## Configuration
55
53
56
54
Flow Scanner can be configured and the action will look for a .flow-scanner file in your repository root, such as:
@@ -76,12 +74,12 @@ For example:
76
74
77
75
If no configurations are found, the scanner falls back to the default rules/threshold.
78
76
79
-
## Development Setup
77
+
## Development
80
78
81
79
To debug the action locally you need to ensure you have `npm` and `act` installed and follow these steps:
82
80
83
81
1. Run `npm run build` to compile a new version
84
82
2. Run act: Use the act command to run the workflow:
85
83
`act workflow_dispatch --secret-file .secrets`
86
84
87
-
If you'd like to help us enhance Flow Scanner, please consider having a look at the [Contributing Guidelines](https://github.com/Flow-Scanner/lightning-flow-scanner-core/blob/main/CONTRIBUTING.md).
85
+
Want to help improve Lightning Flow Scanner? See our [Contributing Guidelines](https://github.com/Flow-Scanner/lightning-flow-scanner-core/blob/main/CONTRIBUTING.md).
0 commit comments