Skip to content

Add Self Validation section to README.md and User Guide #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Malcolmnixon merged 6 commits into from
Mar 4, 2026
Merged

Add Self Validation section to README.md and User Guide #51

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
848e3aa
Initial plan
Copilot Mar 3, 2026
346f8ae
Add Self Validation section to README.md
Copilot Mar 3, 2026
8d5dd97
Address review feedback on Self Validation section
Copilot Mar 3, 2026
eba1cf3
Reformat Self Validation section to match SpdxTool style
Copilot Mar 4, 2026
04fffe2
Reformat user guide Self-Validation section to match SpdxTool guide s…
Copilot Mar 4, 2026
065a655
Print test names instead of descriptions in self-validation output
Copilot Mar 4, 2026
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
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,25 @@ 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 the following system information:

| 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 are performed:
Comment thread
Malcolmnixon marked this conversation as resolved.
Outdated

- **Version Display** (`TemplateTool_VersionDisplay`) - Proves that the `--version`
Comment thread
Malcolmnixon marked this conversation as resolved.
Outdated
flag correctly outputs the tool version string.
- **Help Display** (`TemplateTool_HelpDisplay`) - Proves that the `--help` flag
correctly outputs usage and options information.

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

Generated documentation includes:
Expand Down