Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,26 @@ templatetool --silent --log output.log
| `--results <file>` | Write validation results to file (TRX or JUnit format) |
| `--log <file>` | Write output to log file |

## Self Validation
Comment thread
Malcolmnixon marked this conversation as resolved.

Running `templatetool --validate` reports system information and then prints each test
name with its pass or fail result:

| Information | Description |
| :------------- | :----------------------------------------------- |
| Tool Version | The version of the tool being validated |
| Machine Name | The name of the machine running the validation |
| OS Version | The operating system version |
| DotNet Runtime | The .NET runtime version |
| Time Stamp | The UTC date and time of the validation run |

Comment thread
Malcolmnixon marked this conversation as resolved.
The following self-validation tests prove:

- **`TemplateTool_VersionDisplay`** - `--version` outputs a valid version string.
- **`TemplateTool_HelpDisplay`** - `--help` outputs usage and options information.

See the [User Guide][link-guide] for more details on the self-validation tests.

Comment thread
Malcolmnixon marked this conversation as resolved.
## Documentation

Generated documentation includes:
Expand Down Expand Up @@ -99,3 +119,4 @@ By contributing to this project, you agree that your contributions will be licen
[link-quality]: https://sonarcloud.io/dashboard?id=demaconsulting_TemplateDotNetTool
[link-security]: https://sonarcloud.io/dashboard?id=demaconsulting_TemplateDotNetTool
[link-nuget]: https://www.nuget.org/packages/DemaConsulting.TemplateDotNetTool
[link-guide]: https://github.com/demaconsulting/TemplateDotNetTool/blob/main/docs/guide/guide.md
10 changes: 10 additions & 0 deletions docs/guide/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,16 @@ templatetool --validate --results results.trx
The results file format is determined by the file extension: `.trx` for TRX (MSTest) format,
or `.xml` for JUnit format.

## Self-Validation Tests
Comment thread
Malcolmnixon marked this conversation as resolved.
Outdated

The self-validation verifies the tool is functioning correctly in the deployment environment.
The following tests are performed:

| Test Name | Proves |
| ----------------------------- | ----------------------------------------------------- |
| `TemplateTool_VersionDisplay` | `--version` outputs a valid version string |
| `TemplateTool_HelpDisplay` | `--help` outputs usage and options information |

## Silent Mode

Suppress console output:
Expand Down