From 15c89c4def96d6bd0d6aea081488409cfdd729a0 Mon Sep 17 00:00:00 2001
From: Rhys Arkins <rhys@arkins.net>
Date: Fri, 4 May 2018 08:39:43 +0200
Subject: [PATCH] docs: add automergeComment example
---
website/docs/configuration-options.md | 12 +++++++++++-
1 file changed, 11 insertions(+), 1 deletion(-)
diff --git a/website/docs/configuration-options.md b/website/docs/configuration-options.md
index 8fde8b8509..ab821491e9 100644
--- a/website/docs/configuration-options.md
+++ b/website/docs/configuration-options.md
@@ -71,12 +71,22 @@ Warning: GitHub currently has a bug where automerge won't work if a GitHub Organ
## automergeComment
-PR comment to add to trigger automerge. Used only if automergeType=pr-comment.
+PR comment to add to trigger automerge. Used only if `automergeType="pr-comment"`.
| name | value |
| ---- | ------ |
| type | string |
+Example use:
+
+```json
+{
+ "automerge": enabled,
+ "automergeType": "pr-comment",
+ "automergeComment": "@bors: r+"
+}
+```
+
## automergeType
Type of automerge approach to use.
--
GitLab