Skip to content
check-square

GitHub Action

Publish Checkstyle Report

v1.0.0 Latest version

Publish Checkstyle Report

check-square

Publish Checkstyle Report

Annotates files with Checkstyle log outputs

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Publish Checkstyle Report

              
  uses: Juuxel/[email protected]
Learn more about this action in Juuxel/publish-checkstyle-report

Choose a version

Publish Checkstyle Report

Build status License Version

An action that displays Checkstyle errors as inline code annotations.

Example error screenshot

Usage

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

- 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.