https://github.com/iwillspeak/tyrannoport
🦖 For processing TRX files into something more enjoyable 🦖
https://github.com/iwillspeak/tyrannoport
hacktoberfest reportgenerator tests trx trx-testresults trx-to-html unit
Last synced: 2 months ago
JSON representation
🦖 For processing TRX files into something more enjoyable 🦖
- Host: GitHub
- URL: https://github.com/iwillspeak/tyrannoport
- Owner: iwillspeak
- License: mit
- Created: 2021-07-15T18:16:13.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-09T11:44:16.000Z (over 1 year ago)
- Last Synced: 2025-04-10T00:04:53.594Z (2 months ago)
- Topics: hacktoberfest, reportgenerator, tests, trx, trx-testresults, trx-to-html, unit
- Language: C#
- Homepage:
- Size: 397 KB
- Stars: 5
- Watchers: 1
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Tyrannoport
[](https://dev.azure.com/iwillspeak/GitHub/_build/latest?definitionId=8&branchName=main)
[](https://www.fuget.org/packages/Tyrannoport)
🦖 For processing TRX files into something more enjoyable 🦖
## Installation
Tyrannoport is a `dotnet` tool. It can be installed either to a project's
local `dotnet-tools.json`, or globally.
```bash
$ dotnet tool install tyrannoport
```
Or to install globally
```bash
$ dotnet tool install --global tyrannoport
```
The tool can then be run as either `tyrannoport`, or
`dotnet tool run tyrannoport`.
## Usage
Tyrannoport takes one or more TRX file names and generates HTML reports next to
them.
```
$ tyrannoport [report.trx]+
```
Rendering can take place to a separate directory by specifying `--output`:
```
$ tyrannoport --output= [report.trx]+
```
If you are only rendering a single report then output can be a file path to the
summary document instead.
### Cake Build
Tyrannoport can be called directly from Cake build scripts. You will need to
have both the `Tyrannoport` tool, and the `Cake.Tyrannoport` package installed:
```cake
#tool "dotnet:?package=Tyrannoport&version=0.3.21"
#addin "nuget:?package=Cake.Tyrannoport&version=0.3.21"
```
Then in your `build.cake` you can call Tyrannoport:
```c#
Task("Report")
.IsDependentOn("Test")
.Does(() =>
{
Tyrannoport(trxPath);
});
```
For more details [see the example Cake project](https://gist.github.com/iwillspeak/85ecff08bfd587d2a98272f1dd1a2698).
### NUKE Build
Tyrannoport can be called from NUKE by referencing it as a custom tool:
```bash
$ nuke :add-package Tyrannoport --version 0.3.21
```
Then in your `Build.cs`:
```c#
[PackageExecutable("Tyrannoport", "Tyrannoport.dll")]
readonly Tool Tyrannoport;
// ...
Tyrannoport(trxPath);
```
## License
Tyrannoport is [licensed under the MIT license](LICENSE.txt).