https://github.com/samhammerag/dotnet-reviewdog-action

Github action for dotnet code style
https://github.com/samhammerag/dotnet-reviewdog-action

github-actions

Last synced: about 1 month ago
JSON representation

Github action for dotnet code style

• Host: GitHub
• URL: https://github.com/samhammerag/dotnet-reviewdog-action
• Owner: SamhammerAG
• License: mit
• Created: 2021-05-05T11:33:03.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-08-26T06:04:02.000Z (5 months ago)
• Last Synced: 2024-08-27T07:04:54.851Z (5 months ago)
• Topics: github-actions
• Homepage:
• Size: 8.79 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Dotnet Reviewdog Action

Analyzes a dotnet build log file to verify the code style

## Usage

```yaml

    steps:

    - uses: actions/checkout@v2

    - uses: actions/setup-dotnet@v1

      with:

         dotnet-version: 3.1.x

    - run: echo "::remove-matcher owner=csc::"

    - uses: reviewdog/action-setup@v1

    - run: dotnet restore

    - run: dotnet build -c Release --no-restore | tee dotnet.buildlog

    - uses: SamhammerAG/dotnet-reviewdog-action@v1

      with:

        reporter: github-check

        workdir: Sources

```

### Arguments

* name: Optional. The name of the job that is added to your workflow. Default is dotnet.

* build_log_file: Optional. The file that is analyzed. Default is dotnet.buildlog.

* line_exclude_regex: Optional. Exclude specific warnings by a regex. Default is empty. (e.g. ".\*(warning|error) CS0618:.\*")

* github_token: Optional. Default is github.token.

* level: Optional. Report level for reviewdog [info,warning,error]. Default is error.

* reporter: Optional. Reporter of reviewdog command [github-pr-check,github-check,github-pr-review]. Default is github-pr-review.

* fail_on_error: Optional. Exit code for reviewdog when errors are found [true,false] Default is false.

* reviewdog_flags: Optional. Additional reviewdog flags

* workdir: Optional. The directory from which to look for the build log file and run reviewdog. Default '.'

## License

This project is distributed under the [MIT license](LICENSE.md).