Skip to content

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

Merged
kitsuyui merged 1 commit into
mainfrom
fix/docs-undocumented-template-variables-001
Jun 10, 2026
Merged

docs: document Mustache template variables for custom rule messages#841
kitsuyui merged 1 commit into
mainfrom
fix/docs-undocumented-template-variables-001

Conversation

@kitsuyui

@kitsuyui kitsuyui commented Jun 8, 2026

Copy link
Copy Markdown
Owner

Custom rules can use Mustache variables in their message field, but the README
only showed the variables implicitly in the sample code ({{commitId}}, {{matched}}).
Users had to read source code to discover all available variables or to understand that
kind: "pr" and kind: "commit" expose different variable sets.

Changes

  • README.md — add a "Template variables" subsection under "Custom rules" with a
    reference table listing {{prNum}} (pr), {{commitId}} (commit), and {{matched}}
    (both) with their availability and description.

Verification

  • typos README.md — no spelling issues
  • README-only change; action logic is unaffected

@github-actions

github-actions Bot commented Jun 8, 2026

Copy link
Copy Markdown

🎉 Happy commit!

@github-actions

github-actions Bot commented Jun 8, 2026

Copy link
Copy Markdown

Code Metrics Report

main (6709cec) #841 (f7e1de4) +/-
Coverage 99.2% 99.2% 0.0%
Code to Test Ratio 1:0.5 1:0.5 0.0
Test Execution Time 1s 1s 0s
Details
  |                     | main (6709cec) | #841 (f7e1de4) | +/-  |
  |---------------------|----------------|----------------|------|
  | Coverage            |          99.2% |          99.2% | 0.0% |
  |   Files             |              5 |              5 |    0 |
  |   Lines             |            134 |            134 |    0 |
  |   Covered           |            133 |            133 |    0 |
  | Code to Test Ratio  |          1:0.5 |          1:0.5 |  0.0 |
  |   Code              |           1678 |           1678 |    0 |
  |   Test              |            955 |            955 |    0 |
  | Test Execution Time |             1s |             1s |   0s |

Reported by octocov

@kitsuyui
kitsuyui merged commit 016ebee into main Jun 10, 2026
5 checks passed
@kitsuyui
kitsuyui deleted the fix/docs-undocumented-template-variables-001 branch June 10, 2026 14:51
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