Skip to content

docs: document Mustache template variables for custom rule messages #841

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
kitsuyui merged 1 commit into from
Jun 10, 2026
+10 −0
Merged

docs: document Mustache template variables for custom rule messages #841

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
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,16 @@ You can add your own rules with `additional-rules`. The value is a JSON array, a
| `rule` | Yes | Regular expression pattern evaluated against the PR number or commit SHA |
| `message` | Yes | Mustache template rendered into the comment when the rule matches |

### Template variables

The following Mustache variables are available in `message`, depending on `kind`:

| Variable | Available when | Description |
| --- | --- | --- |
| `{{prNum}}` | `kind: "pr"` | Pull request number as a string |
| `{{commitId}}` | `kind: "commit"` | Commit SHA |
| `{{matched}}` | both | First capture of `rule` matched against the target value |

For example, this rule celebrates any commit SHA containing `1`.

```yaml
Expand Down