https://github.com/reupen/msbuild-github-logger

MSBuild logger that emits GitHub Actions annotations for errors and warnings
https://github.com/reupen/msbuild-github-logger

github-actions msbuild-logger visual visual-studio

Last synced: 2 months ago
JSON representation

MSBuild logger that emits GitHub Actions annotations for errors and warnings

• Host: GitHub
• URL: https://github.com/reupen/msbuild-github-logger
• Owner: reupen
• License: 0bsd
• Created: 2022-02-16T19:21:16.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-04-14T18:34:38.000Z (about 3 years ago)
• Last Synced: 2025-10-11T14:13:19.850Z (8 months ago)
• Topics: github-actions, msbuild-logger, visual, visual-studio
• Language: C#
• Homepage:
• Size: 8.79 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# MSBuild logger for GitHub Actions

This is a custom MSBuild logger that emits GitHub Actions annotations for warnings and errors.

These appear in the PR diff:

![PR diff example](https://user-images.githubusercontent.com/12693549/154147610-603c3ebd-50af-4a8c-b9c2-573be3c3eb68.png)

And in the run summary:

![Run summary](https://user-images.githubusercontent.com/12693549/154338298-8023848b-19a9-4494-b581-4be99da2f188.png)

## Requirements

The logger has been tested with Visual Studio 2022 17.1 and 2019 16.11. Similar versions should be compatible.

## Usage

`Reupen.MSBuild.GitHubLogger.dll` needs to be available to the GitHub Actions workflow. This can be achieved either by

downloading it during the workflow run, or commiting it to your repo.

Then, `/logger:path\to\Reupen.MSBuild.GitHubLogger.dll` should be passed to the logger.

For a complete example, see https://github.com/reupen/columns_ui/tree/master/.github/workflows/build.yml.

## Notes

The logger currently logs all warnings and errors. This may not be suitable if your project has a large number of warnings.

Additionally, GitHub Actions has [limits on annotations including a limit of 10 warning and 10 error annotations per step](https://github.community/t/annotation-limitation/17998/2).