Skip to content

docs: recommend output-file over --output jsonl for action users #59

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

Merged
benner merged 3 commits into from
Apr 27, 2026
Merged

docs: recommend output-file over --output jsonl for action users #59

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b57f5cd
docs: document allow-empty and include-merges action inputs
benner Apr 27, 2026
f4c1661
docs: document rev action input for checking a specific commit
benner Apr 27, 2026
5a7072d
docs: document output-file as the action output method
benner Apr 27, 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
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,10 @@ commit-guard --range origin/main..HEAD --output-file results.jsonl
`--output-file` is independent of `--output`: combining both writes JSONL to
both stdout and the file.

In GitHub Actions, `output-file` is the recommended way to get machine-readable
results — text stays in the CI log and the file is accessible to subsequent steps
via `steps.<id>.outputs.output-file`.

### GitHub Actions

```yaml
Expand Down Expand Up @@ -287,6 +291,14 @@ jobs:
range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
```

Check a specific commit SHA (mirrors the positional CLI argument):

```yaml
- uses: benner/commit-guard@v0.15.0
with:
rev: ${{ github.sha }}
```

All inputs are optional and mirror the CLI flags:

```yaml
Expand All @@ -309,6 +321,8 @@ jobs:
require-trailer: 'Closes,Reviewed-by'
max-subject-length: '100'
min-description-length: '10'
allow-empty: 'true'
include-merges: 'true'
output-file: results.jsonl
```

Expand Down
Loading