https://github.com/kiancross/checkstyle-annotations-action

Uploads Checkstyle errors & warnings as GitHub Annotations and decorates the log file output. Unlike other similar Actions, this also works on pull requests from forks and Dependabot.
https://github.com/kiancross/checkstyle-annotations-action

actions checkstyle github-actions

Last synced: 3 months ago
JSON representation

Uploads Checkstyle errors & warnings as GitHub Annotations and decorates the log file output. Unlike other similar Actions, this also works on pull requests from forks and Dependabot.

• Host: GitHub
• URL: https://github.com/kiancross/checkstyle-annotations-action
• Owner: kiancross
• License: mit
• Created: 2021-07-24T21:33:12.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-12-29T02:27:43.000Z (about 1 year ago)
• Last Synced: 2024-10-05T09:03:43.278Z (4 months ago)
• Topics: actions, checkstyle, github-actions
• Language: JavaScript
• Homepage:
• Size: 13.7 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Java Checkstyle Annotations Uploader

[![Continuous Integration](https://github.com/kiancross/checkstyle-annotations-action/actions/workflows/continous-integration.yml/badge.svg?event=push)](https://github.com/kiancross/checkstyle-annotations-action/actions/workflows/continous-integration.yml)

[![License](https://img.shields.io/github/license/kiancross/checkstyle-annotations-action)](https://github.com/kiancross/checkstyle-annotations-action/blob/master/LICENSE)

Uploads Checkstyle errors & warnings as [GitHub Annotations](https://docs.github.com/en/rest/reference/checks#list-check-run-annotations)

and decorates the log file output. Unlike other similar Actions, this

also works on pull requests from forks and Dependabot.

## Usage

```yaml

steps:

 - uses: kiancross/checkstyle-annotations-action@v1

 # Execute Checkstyle

```

Console output for Checkstyle must be enabled. For example, this

Action will not work if the output is only written to an XML file.

## Advanced

No special permissions are required to upload annotations from

forks, as a [Problem Matcher](https://github.com/actions/toolkit/blob/master/docs/problem-matchers.md)

is used. This scans the output of steps for a [specified regular expression](https://github.com/kiancross/checkstyle-annotations-action/blob/master/problem-matcher.json),

which matches Checkstyle's logging format.

## License

The contents of this repository is released under the [MIT License](https://github.com/kiancross/checkstyle-annotations-action/blob/master/LICENSE).