Skip to content

Latest commit

 

History

History
162 lines (108 loc) · 4.16 KB

guide.md

File metadata and controls

162 lines (108 loc) · 4.16 KB

Introduction

Purpose

Template DotNet Tool is a demonstration project that showcases best practices for DEMA Consulting DotNet Tools.

Scope

This user guide covers:

  • Installation instructions
  • Usage examples for common tasks
  • Command-line options reference
  • Practical examples for various scenarios

Continuous Compliance

This template follows the Continuous Compliance methodology, which ensures compliance evidence is generated automatically on every CI run.

Key Practices

  • Requirements Traceability: Every requirement is linked to passing tests, and a trace matrix is auto-generated on each release
  • Linting Enforcement: markdownlint, cspell, and yamllint are enforced before any build proceeds
  • Automated Audit Documentation: Each release ships with generated requirements, justifications, trace matrix, and quality reports
  • CodeQL and SonarCloud: Security and quality analysis runs on every build

Installation

Install the tool globally using the .NET CLI:

dotnet tool install -g DemaConsulting.TemplateDotNetTool

Usage

Display Version

Display the tool version:

templatetool --version

Display Help

Display usage information:

templatetool --help

Self-Validation

Self-validation produces a report demonstrating that Template DotNet Tool is functioning correctly. This is useful in regulated industries where tool validation evidence is required.

Running Validation

To perform self-validation:

templatetool --validate

To save validation results to a file:

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.

Validation Report

The validation report contains the tool version, machine name, operating system version, .NET runtime version, timestamp, and test results.

Example validation report:

# DEMA Consulting Template DotNet Tool

| Information         | Value                                              |
| :------------------ | :------------------------------------------------- |
| Tool Version        | 1.0.0                                              |
| Machine Name        | BUILD-SERVER                                       |
| OS Version          | Ubuntu 22.04.3 LTS                                 |
| DotNet Runtime      | .NET 10.0.0                                        |
| Time Stamp          | 2024-01-15 10:30:00 UTC                            |

✓ TemplateTool_VersionDisplay - Passed
✓ TemplateTool_HelpDisplay - Passed

Total Tests: 2
Passed: 2
Failed: 0

Validation Tests

Each test proves specific functionality works correctly:

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

Silent Mode

Suppress console output:

templatetool --silent

Logging

Write output to a log file:

templatetool --log output.log

Command-Line Options

The following command-line options are supported:

Option Description
-v, --version Display version information
-?, -h, --help Display help message
--silent Suppress console output
--validate Run self-validation
--results <file> Write validation results to file (TRX or JUnit format)
--log <file> Write output to log file

Examples

Example 1: Basic Usage

templatetool

Example 2: Self-Validation with Results

templatetool --validate --results validation-results.trx

Example 3: Silent Mode with Logging

templatetool --silent --log tool-output.log