Skip to content

Commit

Permalink
Update version
Browse files Browse the repository at this point in the history
  • Loading branch information
Tyrrrz committed Jun 1, 2023
1 parent 5c40018 commit 9457147
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 14 deletions.
4 changes: 4 additions & 0 deletions Changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Changelog

## v2.3.2 (01-Jun-2023)

- Changed the special character used to identify replacement tokens inside `annotations.titleFormat` and `annotations.messageFormat` from `$` to `@`. The previous character (`$`) had special meaning inside POSIX shells and required escaping, which resulted in non-uniform syntax across different platforms. The new character (`@`) does not require escaping. For backwards compatibility, the logger will still recognize the `$` character as a replacement token identifier, but it is recommended to switch to the new character (`@`) when possible.

## v2.3.1 (31-May-2023)

- Fixed minor spacing issues in the test summary.
Expand Down
2 changes: 1 addition & 1 deletion Directory.Build.props
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<Project>

<PropertyGroup>
<Version>2.3.1</Version>
<Version>2.3.2</Version>
<Company>Tyrrrz</Company>
<Copyright>Copyright (C) Oleksii Holub</Copyright>
<LangVersion>latest</LangVersion>
Expand Down
26 changes: 13 additions & 13 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ jobs:
run: >
dotnet test
--configuration Release
--logger "GitHubActions;annotations.titleFormat=$test;annotations.messageFormat=$error"
--logger "GitHubActions;annotations.titleFormat=@test;annotations.messageFormat=@error"
```

#### Custom annotation title
Expand All @@ -131,31 +131,31 @@ Use the `annotations.titleFormat` option to specify the annotation title format

The following replacement tokens are available:

- `$test` — replaced with the display name of the test
- `$traits.TRAIT_NAME` — replaced with the value of the trait named `TRAIT_NAME`
- `$error` — replaced with the error message
- `$trace` — replaced with the stack trace
- `$framework` — replaced with the target framework
- `@test` — replaced with the display name of the test
- `@traits.TRAIT_NAME` — replaced with the value of the trait named `TRAIT_NAME`
- `@error` — replaced with the error message
- `@trace` — replaced with the stack trace
- `@framework` — replaced with the target framework

**Default**: `$test`.
**Default**: `@test`.

**Examples**:

- `$test` → `MyTests.Test1`
- `[$traits.Category] $test` → `[UI Tests] MyTests.Test1`
- `$test ($framework)` → `MyTests.Test1 (.NETCoreApp,Version=v6.0)`
- `@test` → `MyTests.Test1`
- `[@traits.Category] @test` → `[UI Tests] MyTests.Test1`
- `@test (@framework)` → `MyTests.Test1 (.NETCoreApp,Version=v6.0)`

#### Custom annotation message

Use the `annotations.messageFormat` option to specify the annotation message format used for reporting test failures.
Supports the same replacement tokens as [`annotations.titleFormat`](#custom-annotation-title).

**Default**: `$error`.
**Default**: `@error`.

**Examples**:

- `$error` → `AssertionException: Expected 'true' but found 'false'`
- `$error\n$trace` → `AssertionException: Expected 'true' but found 'false'`, followed by stacktrace on the next line
- `@error` → `AssertionException: Expected 'true' but found 'false'`
- `@error\n@trace` → `AssertionException: Expected 'true' but found 'false'`, followed by stacktrace on the next line

#### Include passed tests in summary

Expand Down

0 comments on commit 9457147

Please sign in to comment.