Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Tyrrrz committed Mar 1, 2023
1 parent 12436b9 commit 6672d5c
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ By using this project or its source code, for any purpose and in any shape or fo
- You **support Ukraine's territorial integrity, including its claims over temporarily occupied territories of Crimea and Donbas**
- You **reject false narratives perpetuated by Russian state propaganda**

To learn more about the war and how you can help, [click here](https://tyrrrz.me). Glory to Ukraine! 🇺🇦
To learn more about the war and how you can help, [click here](https://tyrrrz.me/ukraine). Glory to Ukraine! 🇺🇦

## Install

Expand All @@ -37,16 +37,14 @@ To learn more about the war and how you can help, [click here](https://tyrrrz.me

## Usage

### Installation

To use **GitHub Actions Test Logger**, follow these steps:

1. Install **GitHubActionsTestLogger** package in your test project
2. Update **Microsoft.NET.Test.Sdk** package in your test project to the latest version
3. Modify your GitHub Actions workflow file by adding `--logger GitHubActions` to `dotnet test`:

```yaml
name: CI
name: main
on: [push, pull_request]

jobs:
Expand Down Expand Up @@ -74,11 +72,11 @@ jobs:
> If you are using **.NET SDK v2.2 or lower**, you need to set the `<CopyLocalLockFileAssemblies>` property to `true` in your test project.
> [Learn more](https://github.com/Tyrrrz/GitHubActionsTestLogger/issues/5#issuecomment-648431667).

### Options
### Customizing behavior

When running `dotnet test`, you can customize the logger's behavior by passing additional options:

```powershell
```sh
dotnet test --logger "GitHubActions;annotations.titleFormat=$test;annotations.messageFormat=$error"
```

Expand Down Expand Up @@ -112,4 +110,4 @@ Supports the same replacement tokens as [`annotations.titleFormat`](#custom-anno
**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\n$trace` → `AssertionException: Expected 'true' but found 'false'`, followed by stacktrace on the next line

0 comments on commit 6672d5c

Please sign in to comment.