docs(site): add missing GitHub Actions inputs and examples#60
Merged
Conversation
Stdin was not shown alongside the other input methods, making it undiscoverable for users who only read the site. Signed-off-by: Nerijus Bendžiūnas <nerijus.bendziunas@gmail.com>
Link the Conventional Commits spec, note breaking-change syntax, and reflect that limits are configurable rather than fixed at 72. Signed-off-by: Nerijus Bendžiūnas <nerijus.bendziunas@gmail.com>
Users placing .commit-guard.toml in a repo root and running commit-guard from a subdirectory may not know the file is still found. Signed-off-by: Nerijus Bendžiūnas <nerijus.bendziunas@gmail.com>
These options shipped in v0.13.0 and v0.15.0 but were never shown on the site, making them undiscoverable without reading the CLI help. Signed-off-by: Nerijus Bendžiūnas <nerijus.bendziunas@gmail.com>
The env var shipped in v0.15.0 but was not visible on the site, leaving users no way to discover it without reading the source. Signed-off-by: Nerijus Bendžiūnas <nerijus.bendziunas@gmail.com>
The --output jsonl and --output-file flags shipped in v0.14.0 and v0.15.0 but were invisible on the site; users had no way to discover machine-readable output without reading the CLI help. Signed-off-by: Nerijus Bendžiūnas <nerijus.bendziunas@gmail.com>
rev, allow-empty, and include-merges were missing from the input list, and the rev and output-file usage patterns had no examples on the site. Signed-off-by: Nerijus Bendžiūnas <nerijus.bendziunas@gmail.com>
Coverage Report
|
||||||||||||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
rev, allow-empty, and include-merges were missing from the input list,
and the rev and output-file usage patterns had no examples on the site.