Skip to content

Commit 3374890

Browse files
authored
Docs: update readme and properties (#12)
1 parent 69a827c commit 3374890

File tree

4 files changed

+501
-81
lines changed

4 files changed

+501
-81
lines changed

README.md

Lines changed: 14 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -4,34 +4,14 @@ Liquid Test Reports are logger extensions for the [Visual Studio Test Platform](
44

55
## Changelog
66

7-
#### 0.2.4
7+
### Latest:
88

9-
**Added**
9+
#### 1.0.1
1010

11-
- [Markdown] Add optional user configurable report titles, usable by setting the title parameter `Title=My test report;`
12-
- [Markdown] Include error stack trace
11+
- Remove pre-release tags 🎉
12+
- Fix: Create drop for test result messages, and replace URIs with strings
1313

14-
**Changed**
15-
16-
- [Markdown] Redesign markdown report for better formatting in GitHub
17-
- [Markdown] Use tables for results
18-
- [Markdown] Use detail elements for content result sets
19-
- [Markdown] Add pass rate per container
20-
- [Markdown] Add overall result and percentages to summary
21-
22-
**Fixed**
23-
- [Markdown] Fix path splitting for container name on non windows machines
24-
25-
#### v0.1.4
26-
27-
**Added**
28-
29-
- [Markdown] Option to exclude run messages from test report enabled through parameter
30-
`IncludeMessages=false;`
31-
32-
**Changed**
33-
34-
- [All] Update targets to .NET standard 2.1 / .NET framework 4.5.1+
14+
[Previous changes](./docs/Changelog.md)
3515

3616

3717
## LiquidTestReports.Markdown
@@ -45,17 +25,20 @@ The Markdown logger package is a ready to use implementation of the test logger
4525

4626
1. Install the markdown logger to your test project by running the following command
4727
`dotnet add package LiquidTestReports.Core`
28+
4829
2. Run the tests using the supplied logger
4930
`dotnet test --logger "liquid.md"`
31+
5032
3. Report will be generated in the test results folder
5133

5234

35+
See also: [Testing .NET Core Apps with GitHub Actions](https://dev.to/kurtmkurtm/testing-net-core-apps-with-github-actions-3i76)
5336

5437

5538
## LiquidTestReports.Custom
5639
[![NuGet Badge](https://buildstats.info/nuget/LiquidTestReports.Custom?includePreReleases=true)](https://www.nuget.org/packages/LiquidTestReports.Custom)
5740

58-
The custom logger package allows you to create your own reports simply by passing the file path of the template to the test logger. The current documentation is still in progress, a list of template properties are available [here](docs/Properties.md).
41+
The custom logger package allows you to create your own reports simply by passing the file path of the template to the test logger. The list of template properties are available [here](docs/Properties.md).
5942

6043
[Sample Report](docs/samples/xUnit.txt) (using example template below)
6144

@@ -86,7 +69,10 @@ The custom logger package allows you to create your own reports simply by passin
8669
4. Report will be generated in the test results folder
8770

8871

89-
More liquid template documentation is available on the [Shopify Github](https://shopify.github.io/liquid/basics/introduction/).
72+
73+
For a more detailed example, take a look at included [Markdown template](.\src\LiquidTestReports.Markdown\Resources\MdReport.md).
74+
75+
*More liquid template and syntax documentation is available on the [Shopify Github](https://shopify.github.io/liquid/basics/introduction/).*
9076

9177
### LiquidTestReports.Core
9278
[![NuGet Badge](https://buildstats.info/nuget/LiquidTestReports.Core?includePreReleases=true)](https://www.nuget.org/packages/LiquidTestReports.Core)
@@ -103,7 +89,7 @@ The core project is utilised by the above two loggers and can be used to impleme
10389

10490
## License
10591

106-
LiquidTestReports is under [BSD 2-Clause License.](https://github.com/kurtmkurtm/LiquidTestReports/blob/master/LICENSE)
92+
**LiquidTestReports** is under [BSD 2-Clause License.](https://github.com/kurtmkurtm/LiquidTestReports/blob/master/LICENSE)
10793

10894
This library utilises the following libraries under the Apache 2.0 license
10995

docs/Changelog.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## Changelog
2+
3+
#### 0.2.4
4+
5+
**Added**
6+
7+
- [Markdown] Add optional user configurable report titles, usable by setting the title parameter `Title=My test report;`
8+
- [Markdown] Include error stack trace
9+
10+
**Changed**
11+
12+
- [Markdown] Redesign markdown report for better formatting in GitHub
13+
- [Markdown] Use tables for results
14+
- [Markdown] Use detail elements for content result sets
15+
- [Markdown] Add pass rate per container
16+
- [Markdown] Add overall result and percentages to summary
17+
18+
**Fixed**
19+
20+
- [Markdown] Fix path splitting for container name on non windows machines
21+
22+
#### v0.1.4
23+
24+
**Added**
25+
26+
- [Markdown] Option to exclude run messages from test report enabled through parameter
27+
`IncludeMessages=false;`
28+
29+
**Changed**
30+
31+
- [All] Update targets to .NET standard 2.1 / .NET framework 4.5.1+

0 commit comments

Comments
 (0)