Skip to content

Commit 554167b

Browse files
dbelyaevCopilot
andauthored
update action info and title (#454)
chore: update action name and description for clarity and purpose chore: enhance action input descriptions for clarity and detail --------- Co-authored-by: Copilot <[email protected]>
1 parent eba544a commit 554167b

File tree

2 files changed

+20
-22
lines changed

2 files changed

+20
-22
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Checkstyle for Java GitHub Action
1+
# Java Checkstyle Reviewer (GitHub Action)
22

33
<!-- Release and Build Status -->
44
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/dbelyaev/action-checkstyle?logo=github&sort=semver)](https://github.com/dbelyaev/action-checkstyle/releases)

action.yml

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,51 @@
1-
name: "Checkstyle for Java"
1+
name: "Java Checkstyle Reviewer"
22
# description should be no more than 125 characters!
3-
description: "🐶 Run checkstyle analysis on Java code and report results directly to pull request with the help of reviewdog."
3+
description: "Enforce Java code standards in PRs with inline feedback. Powered by Checkstyle + reviewdog for GitHub integration."
44
author: "Dmitriy Belyaev"
55
inputs:
66
github_token:
7-
description: "GITHUB_TOKEN"
7+
description: "GitHub token for API authentication. Use secrets.GITHUB_TOKEN for automatic authentication."
88
default: "${{ github.token }}"
99
workdir:
10-
description: "Working directory relative to the root directory."
10+
description: "Working directory for Checkstyle analysis, relative to the repository root."
1111
default: "."
1212
### Flags for reviewdog ###
1313
level:
14-
description: "Report level for reviewdog [info, warning, error]"
14+
description: "Severity level for reported violations [info, warning, error]. Affects GitHub status check results."
1515
default: "info"
1616
reporter:
17-
description: "Reporter of reviewdog command [github-pr-check, github-pr-review]."
17+
description: "How reviewdog reports violations [github-pr-check, github-check, github-pr-review]. See reviewdog documentation for details."
1818
default: "github-pr-check"
1919
filter_mode:
2020
description: |
21-
Filtering mode for the reviewdog command [added, diff_context, file, nofilter].
22-
Default is added.
21+
Filtering mode for reviewdog [added, diff_context, file, nofilter].
22+
Controls which files/lines are analyzed. See reviewdog documentation for details.
2323
default: "added"
2424
fail_level:
2525
description: |
26-
Exits code 1 when errors are found at that level or above. Options are [none, any, error, warning, info]
27-
Default is `none`.
26+
When to fail the workflow [none, any, info, warning, error].
27+
Set to fail when violations at or above the specified severity are found. Default 'none' never fails.
2828
default: "none"
2929
reviewdog_flags:
30-
description: "Additional reviewdog flags"
30+
description: "Additional flags to pass to the reviewdog command."
3131
default: ""
3232
### Flags for checkstyle ###
3333
checkstyle_config:
3434
description: |
35-
Checkstyle configuration specifies which ruleset to apply during scan.
36-
There are two built-in configurations in checkstyle: [google_checks.xml, sun_checks.xml].
37-
google_checks.xml configures Checkstyle for the Google coding conventions (https://google.github.io/styleguide/javaguide.html)
38-
sun_checks.xml configures Checkstyle for the Sun coding conventions (https://www.oracle.com/java/technologies/javase/codeconventions-contents.html)
35+
Checkstyle ruleset to apply during analysis.
36+
Built-in: google_checks.xml (Google Java Style), sun_checks.xml (Sun Code Conventions).
37+
Or provide path to custom config file relative to repository root.
3938
default: "google_checks.xml"
4039
checkstyle_version:
4140
description: |
42-
Checkstyle version to be used during analysis.
43-
For a list of available version numbers go to [Checkstyle release page](https://github.com/checkstyle/checkstyle/releases/).
44-
**IMPORTANT NOTE**
45-
This field will always try to follow Checkstyle releases as close as possible and will use the latest available by default.
46-
If it is not a default preference for your project, please, pin the needed version using this property.
41+
Checkstyle version to use for analysis. See https://github.com/checkstyle/checkstyle/releases/
42+
Default: latest version (automatically updated).
43+
RECOMMENDED: Pin to a specific version in production to ensure consistent builds.
4744
default: ""
4845
properties_file:
4946
description: |
50-
Location of the properties file relative to the root directory. This file serves as a means to resolve repetitive or predefined values within the checkstyle configuration file.
47+
Path to properties file (relative to repository root) for defining variables in Checkstyle config.
48+
Use standard Java properties format (key=value) to centralize configuration values.
5149
default: ""
5250
runs:
5351
using: "docker"

0 commit comments

Comments
 (0)