Skip to content

Commit 7221afe

Browse files
authored
Benchmark test guide (#1189)
Benchmark test guide
1 parent dc6edb1 commit 7221afe

File tree

2 files changed

+28
-1
lines changed

2 files changed

+28
-1
lines changed

Documentation/ReleasePlan.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,32 @@ To get the list of commits between two version use git command
4545
```bash
4646
git log --oneline hashbefore currenthash
4747
```
48+
# How to manually compare latest release with nightly build
49+
50+
Before creating a new release it makes sense to test the new release against a benchmark repository. This can help to determine bugs that haven't been found
51+
by the unit/integration tests. Therefore, coverage of the latest release is compared with our nightly build.
52+
53+
In the following example the benchmark repository refit (https://github.com/reactiveui/refit) is used which already uses coverlet for coverage.
54+
55+
1. Clone the benchmark repository (https://github.com/reactiveui/refit)
56+
57+
2. Check if latest coverlet version is used by the project, otherwise add coverlet to the project (https://github.com/coverlet-coverage/coverlet#installation).
58+
59+
3. Create coverage report for latest coverlet version:
60+
```
61+
dotnet test --collect:"XPlat Code Coverage"
62+
```
63+
64+
4. Update the test projects with the latest nightly build version of coverlet
65+
(https://github.com/coverlet-coverage/coverlet/blob/master/Documentation/ConsumeNightlyBuild.md).
66+
67+
5. Create coverage report for nightly build version by rerunning the tests:
68+
```
69+
dotnet test --collect:"XPlat Code Coverage"
70+
```
71+
72+
6. Check for differences in the coverage reports.
73+
4874

4975
# How to manually release packages to nuget.org
5076

global.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"sdk": {
3-
"version": "5.0.101"
3+
"version": "5.0.101",
4+
"rollForward": "latestMajor"
45
}
56
}

0 commit comments

Comments
 (0)