https://github.com/juuxel/publish-checkstyle-report

An action that displays Checkstyle errors as inline code annotations.
https://github.com/juuxel/publish-checkstyle-report

actions checkstyle

Last synced: 27 days ago
JSON representation

An action that displays Checkstyle errors as inline code annotations.

• Host: GitHub
• URL: https://github.com/juuxel/publish-checkstyle-report
• Owner: Juuxel
• License: mpl-2.0
• Created: 2022-09-07T18:02:38.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-05T09:50:52.000Z (7 months ago)
• Last Synced: 2024-10-03T11:21:43.522Z (about 1 month ago)
• Topics: actions, checkstyle
• Language: TypeScript
• Homepage:
• Size: 190 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Publish Checkstyle Report

![Build status](https://img.shields.io/github/workflow/status/Juuxel/publish-checkstyle-report/Build?style=flat-square)

![License](https://img.shields.io/github/license/Juuxel/publish-checkstyle-report?style=flat-square)

![Version](https://img.shields.io/github/v/tag/Juuxel/publish-checkstyle-report?style=flat-square)

An action that displays [Checkstyle](https://checkstyle.org/) errors as inline code annotations.

![Example error screenshot](example.png)

## Usage

After the workflow step that runs Checkstyle and produces the report XML files, add this action:

```yaml

- name: Publish Checkstyle report

  uses: Juuxel/publish-checkstyle-report@v1

  if: ${{ failure() || success() }}

  with:

    # required: The glob paths to report XML files as a multiline string

    # The format below works for the Gradle Checkstyle plugin with default configurations

    reports: |

      build/reports/checkstyle/*.xml

```

> You can replace `failure() || success()` with just `failure()` if you only want the annotations to appear

> when the build has failed.