diff --git a/lib/config/definitions.js b/lib/config/definitions.js
index 8646c7e7453124f533aeff6f0e769b87eaf8cee4..1690e0aba57c77e6887e86b5939f6129f78b5936 100644
--- a/lib/config/definitions.js
+++ b/lib/config/definitions.js
@@ -626,10 +626,17 @@ const options = [
{
name: 'automergeType',
description:
- 'How to automerge - "branch-merge-commit", "branch-push" or "pr". Branch support is GitHub-only',
+ 'How to automerge - "branch-merge-commit", "branch-push", "pr-comment" or "pr". Branch support is GitHub-only',
type: 'string',
default: 'pr',
},
+ {
+ name: 'automergeComment',
+ description:
+ 'PR comment to add to trigger automerge. Used only if automergeType=pr-comment',
+ type: 'string',
+ default: 'automergeComment',
+ },
{
name: 'requiredStatusChecks',
description:
diff --git a/lib/platform/github/index.js b/lib/platform/github/index.js
index f8b1a9c38d2fcbe3eaf9895bb546da164eeb8426..5eaeb2617264d7071c7403e1d53ba2d30dbc574c 100644
--- a/lib/platform/github/index.js
+++ b/lib/platform/github/index.js
@@ -736,17 +736,29 @@ async function deleteComment(commentId) {
}
async function ensureComment(issueNo, topic, content) {
- logger.debug(`Ensuring comment "${topic}" in #${issueNo}`);
- const body = `### ${topic}\n\n${content}`;
const comments = await getComments(issueNo);
+ let body;
let commentId;
let commentNeedsUpdating;
- comments.forEach(comment => {
- if (comment.body.startsWith(`### ${topic}\n\n`)) {
- commentId = comment.id;
- commentNeedsUpdating = comment.body !== body;
- }
- });
+ if (topic) {
+ logger.debug(`Ensuring comment "${topic}" in #${issueNo}`);
+ body = `### ${topic}\n\n${content}`;
+ comments.forEach(comment => {
+ if (comment.body.startsWith(`### ${topic}\n\n`)) {
+ commentId = comment.id;
+ commentNeedsUpdating = comment.body !== body;
+ }
+ });
+ } else {
+ logger.debug(`Ensuring content-only comment in #${issueNo}`);
+ body = `${content}`;
+ comments.forEach(comment => {
+ if (comment.body === body) {
+ commentId = comment.id;
+ commentNeedsUpdating = false;
+ }
+ });
+ }
if (!commentId) {
await addComment(issueNo, body);
logger.info({ repository: config.repository, issueNo }, 'Added comment');
diff --git a/lib/workers/branch/automerge.js b/lib/workers/branch/automerge.js
index 95ebdcbde45ddcbcaaef6df65f6d94b40f30a869..b9f94eec863d52433d4fd6850e1a26d59ff293b0 100644
--- a/lib/workers/branch/automerge.js
+++ b/lib/workers/branch/automerge.js
@@ -4,7 +4,7 @@ module.exports = {
async function tryBranchAutomerge(config) {
logger.debug('Checking if we can automerge branch');
- if (!config.automerge || config.automergeType === 'pr') {
+ if (!config.automerge || config.automergeType.startsWith('pr')) {
return 'no automerge';
}
const existingPr = await platform.getBranchPr(config.branchName);
diff --git a/lib/workers/pr/index.js b/lib/workers/pr/index.js
index aec92e5a0c5a1305ad57e5f6a96069aeafab358d..964fa43811e0c68b2fdf06fca7a16e206202b419 100644
--- a/lib/workers/pr/index.js
+++ b/lib/workers/pr/index.js
@@ -387,8 +387,12 @@ async function checkAutoMerge(pr, config) {
return false;
}
// Let's merge this
- logger.info(`Automerging #${pr.number}`);
- return platform.mergePr(pr.number, config.branchName);
+ if (config.automergeType === 'pr') {
+ logger.info(`Automerging #${pr.number}`);
+ return platform.mergePr(pr.number, config.branchName);
+ }
+ logger.info(`Applying automerge comment: ${config.automergeComment}`);
+ return platform.ensureComment(pr.number, null, config.automergeComment);
}
logger.debug('No automerge');
return false;
diff --git a/test/config/__snapshots__/index.spec.js.snap b/test/config/__snapshots__/index.spec.js.snap
index e32179a523cf0352ed032219efcd5c1d6756d846..658a9464302d965683481b040f66f97605395b59 100644
--- a/test/config/__snapshots__/index.spec.js.snap
+++ b/test/config/__snapshots__/index.spec.js.snap
@@ -12,6 +12,7 @@ Object {
"assignees": Array [],
"autodiscover": false,
"automerge": false,
+ "automergeComment": "automergeComment",
"automergeType": "pr",
"baseBranches": Array [],
"bazel": Object {
diff --git a/test/platform/github/index.spec.js b/test/platform/github/index.spec.js
index e50b69584fe72eca426f0e62e1899e63de0e6e14..590e03b03d250a5babff20c2c877ec0e6564e2e2 100644
--- a/test/platform/github/index.spec.js
+++ b/test/platform/github/index.spec.js
@@ -1106,6 +1106,16 @@ describe('platform/github', () => {
expect(get.post.mock.calls).toHaveLength(0);
expect(get.patch.mock.calls).toHaveLength(0);
});
+ it('handles comment with no description', async () => {
+ await initRepo({
+ repository: 'some/repo',
+ token: 'token',
+ });
+ get.mockReturnValueOnce({ body: [{ id: 1234, body: '!merge' }] });
+ await github.ensureComment(42, null, '!merge');
+ expect(get.post.mock.calls).toHaveLength(0);
+ expect(get.patch.mock.calls).toHaveLength(0);
+ });
});
describe('ensureCommentRemoval', () => {
it('deletes comment if found', async () => {
diff --git a/test/workers/pr/index.spec.js b/test/workers/pr/index.spec.js
index 18ea14a6695648ab9ab4460ab4e7c1e8bb0cb42b..7e6ae6743250f9ad91ead95289c11b5a332e9308 100644
--- a/test/workers/pr/index.spec.js
+++ b/test/workers/pr/index.spec.js
@@ -60,6 +60,15 @@ describe('workers/pr', () => {
await prWorker.checkAutoMerge(pr, config);
expect(platform.mergePr.mock.calls.length).toBe(1);
});
+ it('should automerge comment', async () => {
+ config.automerge = true;
+ config.automergeType = 'pr-comment';
+ config.automergeComment = '!merge';
+ pr.canRebase = true;
+ platform.getBranchStatus.mockReturnValueOnce('success');
+ await prWorker.checkAutoMerge(pr, config);
+ expect(platform.ensureComment.mock.calls.length).toBe(1);
+ });
it('should not automerge if enabled and pr is mergeable but cannot rebase', async () => {
config.automerge = true;
pr.canRebase = false;
diff --git a/website/docs/configuration-options.md b/website/docs/configuration-options.md
index 2e52a31670070683d3fbad0d89460c78d0d745c7..8fde8b8509718b3a45eeadec7145d657374bd663 100644
--- a/website/docs/configuration-options.md
+++ b/website/docs/configuration-options.md
@@ -69,15 +69,23 @@ Also note that this option can be combined with other nested settings, such as d
Warning: GitHub currently has a bug where automerge won't work if a GitHub Organization has protected their master branch, and there is no way to configure around this. Hence, automerging will try and fail in such situations. This doc will be updated once that bug/limitation is fixed by GitHub.
+## automergeComment
+
+PR comment to add to trigger automerge. Used only if automergeType=pr-comment.
+
+| name | value |
+| ---- | ------ |
+| type | string |
+
## automergeType
Type of automerge approach to use.
-| name | value |
-| ------------ | -------------------------------------------- |
-| type | string |
-| valid values | "branch-merge-commit", "branch-push" or "pr" |
-| default | "pr" |
+| name | value |
+| ------------ | ---------------------------------------------------------- |
+| type | string |
+| valid values | "branch-merge-commit", "branch-push", "pr-comment" or "pr" |
+| default | "pr" |
Renovate will default to automerging after creating PRs, but you can override that to automerge _without_ PRs. There are two ways to merge branch upgrades: merge commits, and branch push.