Skip to content

Post a comment if the linting fails #134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ghostlypi wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Post a comment if the linting fails #134

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
541bfe4
Add comment when linting fails
ghostlypi Apr 2, 2026
93ae2ff
Add count and link to run
ghostlypi Apr 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 24 additions & 1 deletion .github/workflows/check.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ jobs:
permissions:
actions: read
contents: read
pull-requests: write
security-events: write

steps:
Expand All @@ -33,8 +34,30 @@ jobs:
run: ./gradlew build

- name: Lint
id: lint
continue-on-error: true
run: ./gradlew lint

- name: Count lint violations
id: count_violations
if: steps.lint.outcome == 'failure'
run: |
./gradlew lint || echo "::warning::Checkstyle found violations. See the checkstyle-report artifact for details."
count=$(grep -r '<error ' build/reports/checkstyle/ | wc -l)
echo "count=$count" >> $GITHUB_OUTPUT

- name: Comment on PR if lint failed
if: steps.lint.outcome == 'failure' && github.event_name == 'pull_request'
uses: actions/github-script@v6
with:
script: |
const count = ${{ steps.count_violations.outputs.count }};
const runUrl = `${context.serverUrl}/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId}`;
github.rest.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: `:warning: **Checkstyle found ${count} style violation${count === 1 ? '' : 's'}.** Download the **checkstyle-report** artifact from the [Actions run](${runUrl}) for details.`
})

- name: Determine artifact name
id: find_artifact
Expand Down
Loading