esbenwiberg/spec-lint

Lint markdown spec folders. Path A quality rules + Path B coupling rules.

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Activelast commit May 27, 2026
License: None

Pinned Snippet

workflow.ymlSHA-pinned

uses: esbenwiberg/spec-lint@e2b0fab1d9dd50f983d24d6275d7c06454dee102 # v0.5.0

tags can be moved; commit SHAs can't. why a SHA?

Inputs

name	description	required	default
path	Working directory to lint.	no	.
base-ref	Git ref to diff against for Path B coupling rules. Defaults to the PR base branch on `pull_request` events and to `HEAD~1` on `push` events. Set to an empty string to disable Path B.	no	""
fail-on	`error` \| `warn` \| `never` — exit-code threshold.	no	error
comment	Post a sticky PR comment with the report. Has no effect outside PR events.	no	true
python-version	Python version for the runner.	no	3.12
speclint-version	Version of spec-lint to install. Use a PEP 508 spec (e.g. `>=0.1,<0.2`) or a git ref (`git+https://github.com/.../spec-lint@<sha>`). Defaults to installing this checked-out repo (editable), suitable for self-testing.	no	""
github-token	Token used to post PR comments. Defaults to ${{ github.token }}.	no	${{ github.token }}

Outputs

name	description
exit-code	Exit code from `speclint check` (0 = passed at threshold).
report-markdown-path	Path to the rendered markdown report on the runner.
report-json-path	Path to the JSON report on the runner.