Skip to content

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

Merged
benner merged 3 commits into
mainfrom
docs/update-readme-action-inputs
Apr 27, 2026
Merged

docs: recommend output-file over --output jsonl for action users#59
benner merged 3 commits into
mainfrom
docs/update-readme-action-inputs

Conversation

@benner
Copy link
Copy Markdown
Owner

@benner benner commented Apr 27, 2026

  • docs: recommend output-file over --output jsonl for action users
  • docs: document rev action input for checking a specific commit
  • docs: document allow-empty and include-merges action inputs

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 27, 2026

Coverage

Coverage Report
FileStmtsMissCoverMissing
src/git_commit_guard
   __init__.py341299%216, 598
TOTAL341299% 

benner added 2 commits April 27, 2026 21:44
Both inputs exist in action.yml but were absent from the comprehensive
example in the GitHub Actions section of the README.

Signed-off-by: Nerijus Bendžiūnas <nerijus.bendziunas@gmail.com>
The rev input mirrors the positional CLI argument and lets the action
check a specific commit SHA without a run: step. It was entirely absent
from the GitHub Actions section, leaving users unaware this was possible.

Signed-off-by: Nerijus Bendžiūnas <nerijus.bendziunas@gmail.com>
@benner benner force-pushed the docs/update-readme-action-inputs branch from 594364b to 3cd5051 Compare April 27, 2026 18:45
--output jsonl writes to stdout, which Actions steps can't easily pass
to subsequent steps. output-file writes to a file exposed via outputs,
making results accessible downstream.

Signed-off-by: Nerijus Bendžiūnas <nerijus.bendziunas@gmail.com>
@benner benner force-pushed the docs/update-readme-action-inputs branch from 3cd5051 to 5a7072d Compare April 27, 2026 18:49
@benner benner marked this pull request as ready for review April 27, 2026 18:50
@benner benner merged commit fdd0675 into main Apr 27, 2026
4 checks passed
@benner benner deleted the docs/update-readme-action-inputs branch April 27, 2026 18:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant