Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
4f7f632
feat: render structured output for step log, job summary, and PR comm…
shenxianpeng Aug 4, 2026
a16b263
fix: make stdout UTF-8 for Windows runners
shenxianpeng Aug 4, 2026
bd5f63d
refactor: unify job summary and PR comment rendering
shenxianpeng Aug 4, 2026
56a590d
refactor: split report title and status into separate lines
shenxianpeng Aug 4, 2026
aeb58ed
feat: show passed checks in a collapsible section on success
shenxianpeng Aug 4, 2026
ccbfcd0
refactor: render passed checks like the step log in the details block
shenxianpeng Aug 4, 2026
775fc7f
feat: show checked values in the success details block
shenxianpeng Aug 4, 2026
3f3afb1
refactor: truncate checked values at 60 chars in the details block
shenxianpeng Aug 4, 2026
532e527
feat: show checked values in the failure table
shenxianpeng Aug 4, 2026
257ae28
feat: show only failed values in the table and all checks in details
shenxianpeng Aug 4, 2026
bbba5cd
feat: add CodSpeed-style pass/fail stats to the report header
shenxianpeng Aug 5, 2026
681bf18
feat: reduce the report table to failed scopes
shenxianpeng Aug 5, 2026
c63ebfd
docs: document the report output spec and pin it with golden tests
shenxianpeng Aug 5, 2026
886cd8e
fix: wire the result output through action.yml
shenxianpeng Aug 5, 2026
9d12bd9
feat: rework the report format and identify comments by a hidden marker
shenxianpeng Aug 5, 2026
a280b6d
fix: count things checked, not rule evaluations
shenxianpeng Aug 5, 2026
46b4737
fix: print the failure reason once and keep the log tree intact
shenxianpeng Aug 5, 2026
30357af
fix: show the failing value in full and render one tree, not two
shenxianpeng Aug 5, 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
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,34 @@ for all available options.
> [Optional Inputs](#optional-inputs), so env vars and config files are the
> recommended way to customize.

## Outputs

### `result`

Structured check results as JSON, available to downstream steps via
[`fromJSON`](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/accessing-contextual-information-about-workflow-runs#fromjson):

```yaml
- uses: commit-check/commit-check-action@v2
id: commit-check
with:
dry-run: true # (1)

- name: Inspect results
run: |
echo "Status: ${{ fromJSON(steps.commit-check.outputs.result).status }}"
echo "Scopes: ${{ toJSON(fromJSON(steps.commit-check.outputs.result).scopes) }}"
```

1. Without `dry-run`, a failing check ends the job before any later step runs.
Use `dry-run` (or `continue-on-error`) when a downstream step is meant to
read the result and decide for itself.

Each scope carries the check outcomes (`rule_id`, `check`, `status`, `value`,
`error`, `suggest`, `docs_url`) exactly as produced by
`commit-check --format json`, so downstream jobs can build their own reports
or gate on individual rules.

## GitHub Action Job Summary

By default, commit-check-action results are shown on the job summary page of the workflow.
Expand Down
9 changes: 9 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,19 @@ inputs:
description: check pull request title following conventional commits
required: false
default: false
outputs:
result:
description: Structured check results as JSON (status + per-scope checks). Consume with fromJSON(steps.<id>.outputs.result).
# Composite actions do not forward step outputs automatically: without this
# mapping (and the step id it refers to) the output is always the empty
# string, and fromJSON('') fails the calling workflow.
value: ${{ steps.commit-check.outputs.result }}

Comment thread
coderabbitai[bot] marked this conversation as resolved.
runs:
using: "composite"
steps:
- name: Install dependencies and run commit-check
id: commit-check
shell: bash
run: |
# Platform-specific settings
Expand Down
Binary file added assets/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading