Skip to content

Commit a10c40f

Browse files
authored
Merge pull request #8 from rmuraix/fix-link
Fix #6 - Fix bad link references
2 parents 6b2948b + 1fd2014 commit a10c40f

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Every input is of type string.
4141

4242
To provide an array follow the format `'"value.fake", "value1.fake", ....'`
4343
## path
44-
Specifies the path to the scripts or module to be analyzed. Wildcard characters are supported. Default value is: `.\`. More info [here](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/markdown/Invoke-ScriptAnalyzer.md#-path).
44+
Specifies the path to the scripts or module to be analyzed. Wildcard characters are supported. Default value is: `.\`. More info [here](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Cmdlets/Invoke-ScriptAnalyzer.md#-path).
4545
```yaml
4646
with:
4747
path: .\
@@ -51,7 +51,7 @@ with:
5151
path: .\src
5252
```
5353
## customRulePath
54-
Specifies the path to the scripts or module to be analyzed. Wildcard characters are supported. More info [here](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/markdown/Invoke-ScriptAnalyzer.md#-customrulepath).
54+
Specifies the path to the scripts or module to be analyzed. Wildcard characters are supported. More info [here](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Cmdlets/Invoke-ScriptAnalyzer.md#-customrulepath).
5555
```yaml
5656
with:
5757
customRulePath: '".\customRule.ps1"'
@@ -62,7 +62,7 @@ with:
6262
```
6363
6464
## recurseCustomRulePath
65-
Uses only the custom rules defined in the specified paths to the analysis. To still use the built-in rules, add the -IncludeDefaultRules switch. More info [here](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/markdown/Invoke-ScriptAnalyzer.md#-recursecustomrulepath).
65+
Uses only the custom rules defined in the specified paths to the analysis. To still use the built-in rules, add the -IncludeDefaultRules switch. More info [here](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Cmdlets/Invoke-ScriptAnalyzer.md#-recursecustomrulepath).
6666
```yaml
6767
with:
6868
recurseCustomRulePath: true
@@ -73,7 +73,7 @@ with:
7373
```
7474
7575
## excludeRule
76-
Omits the specified rules from the Script Analyzer test. Wildcard characters are supported. More info [here](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/markdown/Invoke-ScriptAnalyzer.md#-excluderule).
76+
Omits the specified rules from the Script Analyzer test. Wildcard characters are supported. More info [here](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Cmdlets/Invoke-ScriptAnalyzer.md#-excluderule).
7777
```yaml
7878
with:
7979
# exclude one rule
@@ -86,7 +86,7 @@ with:
8686
```
8787
8888
## includeDefaultRules
89-
Uses only the custom rules defined in the specified paths to the analysis. To still use the built-in rules, add the -IncludeDefaultRules switch. More info [here](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/markdown/Invoke-ScriptAnalyzer.md#-includedefaultrules).
89+
Uses only the custom rules defined in the specified paths to the analysis. To still use the built-in rules, add the -IncludeDefaultRules switch. More info [here](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Cmdlets/Invoke-ScriptAnalyzer.md#-includedefaultrules).
9090
```yaml
9191
with:
9292
includeDefaultRules: true
@@ -97,7 +97,7 @@ with:
9797
```
9898
9999
## includeRule
100-
Runs only the specified rules in the Script Analyzer test. More info [here](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/markdown/Invoke-ScriptAnalyzer.md#-includerule).
100+
Runs only the specified rules in the Script Analyzer test. More info [here](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Cmdlets/Invoke-ScriptAnalyzer.md#-includerule).
101101
```yaml
102102
with:
103103
# Include one rule
@@ -110,7 +110,7 @@ with:
110110
```
111111
112112
## severity
113-
After running Script Analyzer with all rules, this parameter selects rule violations with the specified severity. More info [here](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/markdown/Invoke-ScriptAnalyzer.md#-severity).
113+
After running Script Analyzer with all rules, this parameter selects rule violations with the specified severity. More info [here](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Cmdlets/Invoke-ScriptAnalyzer.md#-severity).
114114
```yaml
115115
with:
116116
# Report only rule violations with error severity
@@ -122,7 +122,7 @@ with:
122122
severity: '"Error", "Warning"'
123123
```
124124
## recurse
125-
s Script Analyzer on the files in the Path directory and all subdirectories recursively. More info [here](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/markdown/Invoke-ScriptAnalyzer.md#-recurse).
125+
Script Analyzer on the files in the Path directory and all subdirectories recursively. More info [here](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Cmdlets/Invoke-ScriptAnalyzer.md#-recurse).
126126
```yaml
127127
with:
128128
recurse: true
@@ -133,7 +133,7 @@ with:
133133
```
134134
135135
## suppressedOnly
136-
Returns rules that are suppressed, instead of analyzing the files in the path. More info [here](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/markdown/Invoke-ScriptAnalyzer.md#-suppressedonly).
136+
Returns rules that are suppressed, instead of analyzing the files in the path. More info [here](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Cmdlets/Invoke-ScriptAnalyzer.md#-suppressedonly).
137137
```yaml
138138
with:
139139
suppressedOnly: true
@@ -144,7 +144,7 @@ with:
144144
```
145145
146146
## fix
147-
Fixes certain warnings which contain a fix in their DiagnosticRecord. More info [here](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/markdown/Invoke-ScriptAnalyzer.md#-fix).
147+
Fixes certain warnings which contain a fix in their DiagnosticRecord. More info [here](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Cmdlets/Invoke-ScriptAnalyzer.md#-fix).
148148
```yaml
149149
with:
150150
fix: true
@@ -155,7 +155,7 @@ with:
155155
```
156156
157157
## enableExit
158-
Exits PowerShell and returns an exit code equal to the number of error records. More info [here](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/markdown/Invoke-ScriptAnalyzer.md#-enableexit).
158+
Exits PowerShell and returns an exit code equal to the number of error records. More info [here](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Cmdlets/Invoke-ScriptAnalyzer.md#-enableexit).
159159
```yaml
160160
with:
161161
enableExit: true
@@ -167,7 +167,7 @@ with:
167167
```
168168
169169
## settings
170-
File path that contains user profile or hash table for ScriptAnalyzer. Does not support passing a hashtable as an argument. More info [here](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/markdown/Invoke-ScriptAnalyzer.md#-settings).
170+
File path that contains user profile or hash table for ScriptAnalyzer. Does not support passing a hashtable as an argument. More info [here](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Cmdlets/Invoke-ScriptAnalyzer.md#-settings).
171171
```yaml
172172
with:
173173
settings: .\settings.psd1

workflow.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ jobs:
2222
- name: Run PSScriptAnalyzer
2323
uses: ./
2424
with:
25-
# Check https://github.com/microsoft/action-psscriptanalyzer for more info about the options.
25+
# Check https://github.com/microsoft/psscriptanalyzer-action for more info about the options.
2626
# The below set up runs PSScriptAnalyzer to your entire repository and runs some basic security rules.
2727
path: .\
2828
recurse: true

0 commit comments

Comments
 (0)