Skip to content

docs: prepare version pins for upcoming v0.18.0 #72

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 1 commit into from
May 1, 2026
Merged

docs: prepare version pins for upcoming v0.18.0 #72

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ COMMIT_GUARD_GIT_TIMEOUT=30 commit-guard --range origin/main..HEAD
In GitHub Actions, set it at the step or job level:

```yaml
- uses: benner/commit-guard@v0.17.0
- uses: benner/commit-guard@v0.18.0
env:
COMMIT_GUARD_GIT_TIMEOUT: 30
with:
Expand Down Expand Up @@ -309,7 +309,7 @@ steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: benner/commit-guard@v0.17.0
- uses: benner/commit-guard@v0.18.0
```

Check all commits in a pull request:
Expand All @@ -325,15 +325,15 @@ jobs:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: benner/commit-guard@v0.17.0
- uses: benner/commit-guard@v0.18.0
with:
range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
```

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

```yaml
- uses: benner/commit-guard@v0.17.0
- uses: benner/commit-guard@v0.18.0
with:
rev: ${{ github.sha }}
```
Expand All @@ -351,7 +351,7 @@ jobs:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: benner/commit-guard@v0.17.0
- uses: benner/commit-guard@v0.18.0
with:
range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
disable: signed-off,signature
Expand All @@ -370,7 +370,7 @@ jobs:
When `output-file` is set the action exposes the path as an output:

```yaml
- uses: benner/commit-guard@v0.17.0
- uses: benner/commit-guard@v0.18.0
id: cg
with:
range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
Expand All @@ -386,7 +386,7 @@ Add to your `.pre-commit-config.yaml`:
---
repos:
- repo: https://github.com/benner/commit-guard
rev: v0.17.0
rev: v0.18.0
hooks:
- id: commit-guard
- id: commit-guard-signature
Expand Down
8 changes: 4 additions & 4 deletions docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -479,13 +479,13 @@ <h2>GitHub Actions <a href="#github-actions" class="anchor">#</a></h2>
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: benner/commit-guard@v0.17.0
- uses: benner/commit-guard@v0.18.0
with:
range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
disable: signed-off,signature</code></pre>

<p>Check a specific commit SHA:</p>
<pre><code class="language-yaml"> - uses: benner/commit-guard@v0.17.0
<pre><code class="language-yaml"> - uses: benner/commit-guard@v0.18.0
with:
rev: ${{ github.sha }}</code></pre>

Expand All @@ -504,7 +504,7 @@ <h2>GitHub Actions <a href="#github-actions" class="anchor">#</a></h2>
When <code>output-file</code> is set the action exposes the path as
a step output, making JSONL results available to subsequent steps:
</p>
<pre><code class="language-yaml"> - uses: benner/commit-guard@v0.17.0
<pre><code class="language-yaml"> - uses: benner/commit-guard@v0.18.0
id: cg
with:
range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
Expand All @@ -517,7 +517,7 @@ <h2>pre-commit <a href="#pre-commit" class="anchor">#</a></h2>
<p>Add to <code>.pre-commit-config.yaml</code>:</p>
<pre><code class="language-yaml">repos:
- repo: https://github.com/benner/commit-guard
rev: v0.17.0
rev: v0.18.0
hooks:
- id: commit-guard
- id: commit-guard-signature</code></pre>
Expand Down
Loading