Skip to content

Commit e9facc9

Browse files
authored
Merge pull request #405 from parasoft/feature/DT-23338-Update-GitHub-action-documentation-and-defaults
Update README and action.yml to reflect changes in dotTEST configurat…
2 parents 7cb8095 + 4905c4a commit e9facc9

File tree

4 files changed

+10
-8
lines changed

4 files changed

+10
-8
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ We recommend that you run Parasoft dotTEST on a self-hosted rather than GitHub-h
3131

3232
Add the `Run Parasoft dotTEST` action to your workflow to launch code analysis with Parasoft dotTEST.
3333

34-
The following example shows a simple workflow made up of one job "Run code analysis with dotTEST". The example assumes that dotTEST is run on a self-hosted runner and the path to dottestcli.exe is available on PATH.
34+
The following example shows a simple workflow made up of one job "run-dottest-action". The example assumes that dotTEST is run on a self-hosted runner and the path to dottestcli.exe is available on PATH.
3535

3636
```yaml
3737
# This is a basic workflow to help you get started with the Run Parasoft dotTEST action.
@@ -51,8 +51,10 @@ on:
5151

5252
# A workflow run is made up of one or more jobs that can run sequentially or in parallel.
5353
jobs:
54-
# Specifies the name of the job.
55-
Run code analysis with dotTEST:
54+
# This workflow is made up of one job "run-dottest-action".
55+
run-dottest-action:
56+
# Specifies the name of the job.
57+
name: Run code analysis with dotTEST
5658
# Specifies required permissions for upload-sarif action
5759
permissions:
5860
# required for all workflows
@@ -268,7 +270,7 @@ If a pull request is blocked due to failed checks, the administrator can still m
268270
The following inputs are available for this action:
269271
| Input | Description |
270272
| --- | --- |
271-
| `testConfig` | Specifies the URL of the test configuration to be used for analysis. The default is `builtin://Recommended .NET Core Rules`.|
273+
| `testConfig` | Specifies the URL of the test configuration to be used for analysis. The default is `builtin://Recommended .NET Rules`.|
272274
| `exclude` | Specifies the file system paths to files to exclude from analysis. Supports ANT-style wildcards.|
273275
| `fail` | Fails the command with exit code 2 if any findings are reported.|
274276
| `installDir` | Specifies the path to the dotTEST installation directory, which contains dottestcli.exe.|

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ inputs:
2525
testConfig:
2626
description: 'URL of the test configuration to be used for analysis.'
2727
required: false
28-
default: 'builtin://Recommended .NET Core Rules'
28+
default: 'builtin://Recommended .NET Rules'
2929
resource:
3030
description: 'Solution-relative path to a project in a solution, a directory of files in a project, or a file. Use a semicolon-separated list to specify multiple paths.'
3131
required: false

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

samples/run-dottest-analyzer-template.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ jobs:
6060
# Full path to the website directory to be analyzed when no solution is provided.
6161
#website: # optional
6262
# URL of the test configuration to be used for analysis.
63-
#testConfig: # optional, default is builtin://Recommended .NET Core Rules
63+
#testConfig: # optional, default is builtin://Recommended .NET Rules
6464
# Solution-relative path to a project in a solution, a directory of files in a project, or a file.
6565
#resource: # optional
6666
# File system paths to files to include in analysis. Supports ANT-style wildcards. If not specified, all files are analyzed.

0 commit comments

Comments
 (0)