diff --git a/docs/configuration.md b/docs/configuration.md
index 01555b1bd55585caf70b77fcabe9caee10612750..a678802f7eb3bc3b6e644fd9feb179615493ddf1 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -262,6 +262,14 @@ Obviously, you can't set repository or package file location with this method.
<td>`RENOVATE_REPOSITORIES`</td>
<td><td>
</tr>
+<tr>
+ <td>`baseBranch`</td>
+ <td>Base branch to target for Pull Requests. Otherwise default branch is used</td>
+ <td>string</td>
+ <td><pre>null</pre></td>
+ <td></td>
+ <td><td>
+</tr>
<tr>
<td>`packageFiles`</td>
<td>Package file paths</td>
@@ -430,7 +438,7 @@ Obviously, you can't set repository or package file location with this method.
<td>`prBody`</td>
<td>Pull Request body template</td>
<td>string</td>
- <td><pre>"This {{#if isGitHub}}Pull{{else}}Merge{{/if}} Request updates dependency [{{depName}}]({{repositoryUrl}}) from version `{{currentVersion}}` to `{{newVersion}}`\n{{#if releases.length}}\n\n### Commits\n\n<details>\n<summary>{{githubName}}</summary>\n\n{{#each releases as |release|}}\n#### {{release.version}}\n{{#each release.commits as |commit|}}\n- [`{{commit.shortSha}}`]({{commit.url}}) {{commit.message}}\n{{/each}}\n{{/each}}\n\n</details>\n{{/if}}\n\n{{#if hasErrors}}\n\n---\n\n### Errors\n\nRenovate encountered some errors when processing your repository, so you are being notified here even if they do not directly apply to this PR.\n\n{{#each errors as |error|}}\n- `{{error.depName}}`: {{error.message}}\n{{/each}}\n{{/if}}\n\n{{#if hasWarnings}}\n\n---\n\n### Warnings\n\nPlease make sure the following warnings are safe to ignore:\n\n{{#each warnings as |warning|}}\n- `{{warning.depName}}`: {{warning.message}}\n{{/each}}\n{{/if}}\n\n---\n\nThis {{#if isGitHub}}PR{{else}}MR{{/if}} has been generated by [Renovate Bot](https://keylocation.sg/our-tech/renovate)."</pre></td>
+ <td><pre>"This {{#if isGitHub}}Pull{{else}}Merge{{/if}} Request updates dependency [{{depName}}]({{repositoryUrl}}) from version `{{currentVersion}}` to `{{newVersion}}`\n{{#if releases.length}}\n\n{{#if schedule}}\n**Note**: This PR was created on a configured schedule (\"{{schedule}}\"{{#if timezone}} in timezone `{{timezone}}`{{/if}}) and will not receive updates outside those times.\n{{/if}}\n\n### Commits\n\n<details>\n<summary>{{githubName}}</summary>\n\n{{#each releases as |release|}}\n#### {{release.version}}\n{{#each release.commits as |commit|}}\n- [`{{commit.shortSha}}`]({{commit.url}}) {{commit.message}}\n{{/each}}\n{{/each}}\n\n</details>\n{{/if}}\n\n{{#if hasErrors}}\n\n---\n\n### Errors\n\nRenovate encountered some errors when processing your repository, so you are being notified here even if they do not directly apply to this PR.\n\n{{#each errors as |error|}}\n- `{{error.depName}}`: {{error.message}}\n{{/each}}\n{{/if}}\n\n{{#if hasWarnings}}\n\n---\n\n### Warnings\n\nPlease make sure the following warnings are safe to ignore:\n\n{{#each warnings as |warning|}}\n- `{{warning.depName}}`: {{warning.message}}\n{{/each}}\n{{/if}}\n\n---\n\nThis {{#if isGitHub}}PR{{else}}MR{{/if}} has been generated by [Renovate Bot](https://keylocation.sg/our-tech/renovate)."</pre></td>
<td>`RENOVATE_PR_BODY`</td>
<td><td>
</tr>
@@ -491,7 +499,7 @@ Obviously, you can't set repository or package file location with this method.
"branchName": "renovate/{{groupSlug}}",
"commitMessage": "{{semanticPrefix}}Renovate {{groupName}} packages",
"prTitle": "{{semanticPrefix}}Renovate {{groupName}} packages",
- "prBody": "This {{#if isGitHub}}Pull{{else}}Merge{{/if}} Request renovates the package group \"{{groupName}}\".\n\n{{#each upgrades as |upgrade|}}\n- [{{upgrade.depName}}]({{upgrade.repositoryUrl}}): from `{{upgrade.currentVersion}}` to `{{upgrade.newVersion}}`\n{{/each}}\n\n{{#unless isPin}}\n### Commits\n\n{{#each upgrades as |upgrade|}}\n{{#if upgrade.releases.length}}\n<details>\n<summary>{{upgrade.githubName}}</summary>\n{{#each upgrade.releases as |release|}}\n\n#### {{release.version}}\n{{#each release.commits as |commit|}}\n- [`{{commit.shortSha}}`]({{commit.url}}){{commit.message}}\n{{/each}}\n{{/each}}\n\n</details>\n{{/if}}\n{{/each}}\n{{/unless}}\n<br />\n\n{{#if hasErrors}}\n\n---\n\n### Errors\n\nRenovate encountered some errors when processing your repository, so you are being notified here even if they do not directly apply to this PR.\n\n{{#each errors as |error|}}\n- `{{error.depName}}`: {{error.message}}\n{{/each}}\n{{/if}}\n\n{{#if hasWarnings}}\n\n---\n\n### Warnings\n\nPlease make sure the following warnings are safe to ignore:\n\n{{#each warnings as |warning|}}\n- `{{warning.depName}}`: {{warning.message}}\n{{/each}}\n{{/if}}\n\n---\n\nThis {{#if isGitHub}}PR{{else}}MR{{/if}} has been generated by [Renovate Bot](https://keylocation.sg/our-tech/renovate)."
+ "prBody": "This {{#if isGitHub}}Pull{{else}}Merge{{/if}} Request renovates the package group \"{{groupName}}\".\n\n{{#if schedule}}\n**Note**: This PR was created on a configured schedule (\"{{schedule}}\"{{#if timezone}} in timezone `{{timezone}}`{{/if}}) and will not receive updates outside those times.\n{{/if}}\n\n{{#each upgrades as |upgrade|}}\n- [{{upgrade.depName}}]({{upgrade.repositoryUrl}}): from `{{upgrade.currentVersion}}` to `{{upgrade.newVersion}}`\n{{/each}}\n\n{{#unless isPin}}\n### Commits\n\n{{#each upgrades as |upgrade|}}\n{{#if upgrade.releases.length}}\n<details>\n<summary>{{upgrade.githubName}}</summary>\n{{#each upgrade.releases as |release|}}\n\n#### {{release.version}}\n{{#each release.commits as |commit|}}\n- [`{{commit.shortSha}}`]({{commit.url}}){{commit.message}}\n{{/each}}\n{{/each}}\n\n</details>\n{{/if}}\n{{/each}}\n{{/unless}}\n<br />\n\n{{#if hasErrors}}\n\n---\n\n### Errors\n\nRenovate encountered some errors when processing your repository, so you are being notified here even if they do not directly apply to this PR.\n\n{{#each errors as |error|}}\n- `{{error.depName}}`: {{error.message}}\n{{/each}}\n{{/if}}\n\n{{#if hasWarnings}}\n\n---\n\n### Warnings\n\nPlease make sure the following warnings are safe to ignore:\n\n{{#each warnings as |warning|}}\n- `{{warning.depName}}`: {{warning.message}}\n{{/each}}\n{{/if}}\n\n---\n\nThis {{#if isGitHub}}PR{{else}}MR{{/if}} has been generated by [Renovate Bot](https://keylocation.sg/our-tech/renovate)."
}</pre></td>
<td></td>
<td><td>
diff --git a/docs/faq.md b/docs/faq.md
index 15eeaffafda834f5bc87c31a96834edb15f5e859..e1b7dd473f3c29c194ca0a2d6740cb2e5ac0afea 100644
--- a/docs/faq.md
+++ b/docs/faq.md
@@ -21,6 +21,16 @@ Renovate will:
Set configuration option `autodiscover` to `true`, via CLI, environment, or configuration file. Obviously it's too late to set it in any `renovate.json` or `package.json`.
+### Use an alternative branch for Pull Request target
+
+If for example your repository default branch is `master` but your Pull Requests should target branch `next`, then you can configure this via the `baseBranch` configuration option. To do this, add this line to the `renovate.json` in the *default* branch (i.e. `master` in this example).
+
+```json
+{
+ "baseBranch": "next"
+}
+```
+
### Support private npm modules
If you are running your own Renovate instance, then the easiest way to support private modules is to make sure the appropriate credentials are in `~/.npmrc`;
diff --git a/lib/api/github.js b/lib/api/github.js
index 533c81f0daa5f5e0884afb8f738f63bae5b8cb63..cbaa2b67e4581ee41f9964c2e2c856acd4ab1880 100644
--- a/lib/api/github.js
+++ b/lib/api/github.js
@@ -11,6 +11,7 @@ module.exports = {
// Initialization
getRepos,
initRepo,
+ setBaseBranch,
// Search
findFilePaths,
// Branch
@@ -144,7 +145,10 @@ async function initRepo(repoName, token, endpoint, repoLogger) {
const res = await ghGot(`repos/${repoName}`);
config.owner = res.body.owner.login;
logger.debug(`${repoName} owner = ${config.owner}`);
- config.defaultBranch = res.body.default_branch;
+ // Use default branch as PR target unless later overridden
+ config.baseBranch = res.body.default_branch;
+ logger.debug(`${repoName} default branch = ${config.baseBranch}`);
+ config.baseCommitSHA = await getBranchCommit(config.baseBranch);
if (res.body.allow_rebase_merge) {
config.mergeMethod = 'rebase';
} else if (res.body.allow_squash_merge) {
@@ -154,8 +158,6 @@ async function initRepo(repoName, token, endpoint, repoLogger) {
} else {
logger.debug('Could not find allowed merge methods for repo');
}
- logger.debug(`${repoName} default branch = ${config.defaultBranch}`);
- config.baseCommitSHA = await getBranchCommit(config.defaultBranch);
} catch (err) /* istanbul ignore next */ {
logger.error(`GitHub init error: ${JSON.stringify(err)}`);
throw err;
@@ -163,6 +165,13 @@ async function initRepo(repoName, token, endpoint, repoLogger) {
return config;
}
+async function setBaseBranch(branchName) {
+ if (branchName) {
+ config.baseBranch = branchName;
+ config.baseCommitSHA = await getBranchCommit(config.baseBranch);
+ }
+}
+
// Search
// Returns an array of file paths in current repo matching the fileName
@@ -245,7 +254,7 @@ async function getBranchPr(branchName) {
logger.debug(`getBranchPr(${branchName})`);
const gotString =
`repos/${config.repoName}/pulls?` +
- `state=open&base=${config.defaultBranch}&head=${config.owner}:${branchName}`;
+ `state=open&base=${config.baseBranch}&head=${config.owner}:${branchName}`;
const res = await ghGot(gotString);
if (!res.body.length) {
return null;
@@ -283,7 +292,7 @@ async function deleteBranch(branchName) {
async function mergeBranch(branchName, mergeType) {
logger.debug(`mergeBranch(${branchName}, ${mergeType})`);
if (mergeType === 'branch-push') {
- const url = `repos/${config.repoName}/git/refs/heads/${config.defaultBranch}`;
+ const url = `repos/${config.repoName}/git/refs/heads/${config.baseBranch}`;
const options = {
body: {
sha: await getBranchCommit(branchName),
@@ -300,7 +309,7 @@ async function mergeBranch(branchName, mergeType) {
const url = `repos/${config.repoName}/merges`;
const options = {
body: {
- base: config.defaultBranch,
+ base: config.baseBranch,
head: branchName,
},
};
@@ -315,7 +324,7 @@ async function mergeBranch(branchName, mergeType) {
throw new Error(`Unsupported branch merge type: ${mergeType}`);
}
// Update base commit
- config.baseCommitSHA = await getBranchCommit(config.defaultBranch);
+ config.baseCommitSHA = await getBranchCommit(config.baseBranch);
// Delete branch
await deleteBranch(branchName);
}
@@ -386,7 +395,12 @@ async function checkForClosedPr(branchName, prTitle) {
// Creates PR and returns PR number
async function createPr(branchName, title, body) {
const pr = (await ghGot.post(`repos/${config.repoName}/pulls`, {
- body: { title, head: branchName, base: config.defaultBranch, body },
+ body: {
+ title,
+ head: branchName,
+ base: config.baseBranch,
+ body,
+ },
})).body;
pr.displayNumber = `Pull Request #${pr.number}`;
return pr;
@@ -513,21 +527,21 @@ async function mergePr(pr) {
}
}
// Update base branch SHA
- config.baseCommitSHA = await getBranchCommit(config.defaultBranch);
+ config.baseCommitSHA = await getBranchCommit(config.baseBranch);
// Delete branch
await deleteBranch(pr.head.ref);
}
// Generic File operations
-async function getFile(filePath, branchName = config.defaultBranch) {
+async function getFile(filePath, branchName = config.baseBranch) {
const res = await ghGot(
`repos/${config.repoName}/contents/${filePath}?ref=${branchName}`
);
return res.body.content;
}
-async function getFileContent(filePath, branchName = config.defaultBranch) {
+async function getFileContent(filePath, branchName = config.baseBranch) {
try {
const file = await getFile(filePath, branchName);
return new Buffer(file, 'base64').toString();
@@ -541,7 +555,7 @@ async function getFileContent(filePath, branchName = config.defaultBranch) {
}
}
-async function getFileJson(filePath, branchName = config.defaultBranch) {
+async function getFileJson(filePath, branchName = config.baseBranch) {
let fileJson = null;
try {
fileJson = JSON.parse(await getFileContent(filePath, branchName));
@@ -556,7 +570,7 @@ async function commitFilesToBranch(
branchName,
files,
message,
- parentBranch = config.defaultBranch
+ parentBranch = config.baseBranch
) {
logger.debug(
`commitFilesToBranch('${branchName}', files, message, '${parentBranch})'`
diff --git a/lib/api/gitlab.js b/lib/api/gitlab.js
index 5fe2e455528b43497325ad4eda849d50effaad9a..a4e81e332acb7286cb22ce540a864bce6033431c 100644
--- a/lib/api/gitlab.js
+++ b/lib/api/gitlab.js
@@ -6,6 +6,7 @@ const config = {};
module.exports = {
getRepos,
initRepo,
+ setBaseBranch,
// Search
findFilePaths,
// Branch
@@ -96,8 +97,8 @@ async function initRepo(repoName, token, endpoint, repoLogger) {
config.repoName = repoName.replace('/', '%2F');
try {
const res = await glGot(`projects/${config.repoName}`);
- config.defaultBranch = res.body.default_branch;
- logger.debug(`${repoName} default branch = ${config.defaultBranch}`);
+ config.baseBranch = res.body.default_branch;
+ logger.debug(`${repoName} default branch = ${config.baseBranch}`);
// Discover our user email
config.email = (await glGot(`user`)).body.email;
} catch (err) {
@@ -107,6 +108,12 @@ async function initRepo(repoName, token, endpoint, repoLogger) {
return config;
}
+async function setBaseBranch(branchName) {
+ if (branchName) {
+ config.baseBranch = branchName;
+ }
+}
+
// Search
// Returns an array of file paths in current repo matching the fileName
@@ -285,7 +292,7 @@ async function createPr(branchName, title, body) {
const res = await glGot.post(`projects/${config.repoName}/merge_requests`, {
body: {
source_branch: branchName,
- target_branch: config.defaultBranch,
+ target_branch: config.baseBranch,
remove_source_branch: true,
title,
description,
@@ -347,7 +354,7 @@ async function mergePr(pr) {
// Generic File operations
-async function getFile(filePath, branchName = config.defaultBranch) {
+async function getFile(filePath, branchName = config.baseBranch) {
// Gitlab API v3 support
let url;
if (config.apiVersion === 'v3') {
@@ -433,7 +440,7 @@ async function commitFilesToBranch(
branchName,
files,
message,
- parentBranch = config.defaultBranch
+ parentBranch = config.baseBranch
) {
logger.debug(
`commitFilesToBranch('${branchName}', files, message, '${parentBranch})'`
@@ -462,7 +469,7 @@ async function commitFilesToBranch(
// Internal branch operations
// Creates a new branch with provided commit
-async function createBranch(branchName, ref = config.defaultBranch) {
+async function createBranch(branchName, ref = config.baseBranch) {
// Gitlab API v3 support
const opts = {};
if (config.apiVersion === 'v3') {
diff --git a/lib/config/definitions.js b/lib/config/definitions.js
index 4893f2444209b7ee948e66d57262c3a50fa406e1..bcf4262c16b5917cb10b86c6ee9dd3283dde2019 100644
--- a/lib/config/definitions.js
+++ b/lib/config/definitions.js
@@ -125,6 +125,16 @@ const options = [
type: 'list',
cli: false,
},
+ {
+ name: 'baseBranch',
+ description:
+ 'Base branch to target for Pull Requests. Otherwise default branch is used',
+ stage: 'repository',
+ type: 'string',
+ cli: false,
+ env: false,
+ onboarding: false,
+ },
{
name: 'packageFiles',
description: 'Package file paths',
diff --git a/lib/workers/repository/index.js b/lib/workers/repository/index.js
index 82f738cbf232f6d9cc61a4cd91dd7bf35c796375..264cb959dfa13cdcd90499b15b812f6c6f83666d 100644
--- a/lib/workers/repository/index.js
+++ b/lib/workers/repository/index.js
@@ -22,6 +22,18 @@ async function renovateRepository(packageFileConfig) {
config.logger.debug('repository is disabled');
return;
}
+ if (config.baseBranch) {
+ if (await config.api.branchExists(config.baseBranch)) {
+ await config.api.setBaseBranch(config.baseBranch);
+ } else {
+ const message = `The configured baseBranch "${config.baseBranch}" is not present. Ignoring`;
+ config.errors.push({
+ depName: 'baseBranch',
+ message,
+ });
+ config.logger.warn(message);
+ }
+ }
if (config.packageFiles.length === 0) {
config.logger.debug('Detecting package files');
config = await apis.detectPackageFiles(config);
diff --git a/lib/workers/repository/onboarding.js b/lib/workers/repository/onboarding.js
index 1ae2bf9f1327990317f613ec823e10b6cb32825e..574dce997d96bdec97349626c4f1525b5d5e831e 100644
--- a/lib/workers/repository/onboarding.js
+++ b/lib/workers/repository/onboarding.js
@@ -37,7 +37,7 @@ This is an onboarding PR to help you understand and configure Renovate before an
---
-{{PRDESCRIPTION}}
+{{BASEBRANCHDESCRIPTION}}{{PRDESCRIPTION}}
Would you like to change this? Simply edit the \`renovate.json\` in this branch and Renovate will update this Pull Request description the next time it runs.
@@ -79,6 +79,13 @@ Please make any fixes in _this branch_.
prBody = prBody.replace('---', prErrors);
}
+ // Describe base branch only if it's configured
+ let baseBranchDesc = '';
+ if (config.baseBranch) {
+ baseBranchDesc = `You have configured renovate to use branch \`${config.baseBranch}\` as base branch.\n\n`;
+ }
+ prBody = prBody.replace('{{BASEBRANCHDESCRIPTION}}', baseBranchDesc);
+
let prDesc = `
With your current configuration, renovate will initially create the following Pull Requests:
diff --git a/test/api/__snapshots__/github.spec.js.snap b/test/api/__snapshots__/github.spec.js.snap
index 534765778917aa41cd1271f001fc67cb5cfd6bf0..4dc2fc3346d67e7de4043321853f58abe628c63e 100644
--- a/test/api/__snapshots__/github.spec.js.snap
+++ b/test/api/__snapshots__/github.spec.js.snap
@@ -720,8 +720,8 @@ Array [
exports[`api/github initRepo should initialise the config for the repo - 0 2`] = `
Object {
+ "baseBranch": "master",
"baseCommitSHA": "1234",
- "defaultBranch": "master",
"mergeMethod": "rebase",
"owner": "theowner",
"repoName": "some/repo",
@@ -741,8 +741,8 @@ Array [
exports[`api/github initRepo should initialise the config for the repo - 1 2`] = `
Object {
+ "baseBranch": "master",
"baseCommitSHA": "1234",
- "defaultBranch": "master",
"mergeMethod": "rebase",
"owner": "theowner",
"repoName": "some/repo",
@@ -762,8 +762,8 @@ Array [
exports[`api/github initRepo should initialise the config for the repo - 2 2`] = `
Object {
+ "baseBranch": "master",
"baseCommitSHA": "1234",
- "defaultBranch": "master",
"mergeMethod": "rebase",
"owner": "theowner",
"repoName": "some/repo",
@@ -772,8 +772,8 @@ Object {
exports[`api/github initRepo should merge 1`] = `
Object {
+ "baseBranch": "master",
"baseCommitSHA": "1234",
- "defaultBranch": "master",
"mergeMethod": "merge",
"owner": "theowner",
"repoName": "some/repo",
@@ -782,8 +782,8 @@ Object {
exports[`api/github initRepo should not guess at merge 1`] = `
Object {
+ "baseBranch": "master",
"baseCommitSHA": "1234",
- "defaultBranch": "master",
"owner": "theowner",
"repoName": "some/repo",
}
@@ -791,8 +791,8 @@ Object {
exports[`api/github initRepo should rebase 1`] = `
Object {
+ "baseBranch": "master",
"baseCommitSHA": "1234",
- "defaultBranch": "master",
"mergeMethod": "rebase",
"owner": "theowner",
"repoName": "some/repo",
@@ -801,8 +801,8 @@ Object {
exports[`api/github initRepo should squash 1`] = `
Object {
+ "baseBranch": "master",
"baseCommitSHA": "1234",
- "defaultBranch": "master",
"mergeMethod": "squash",
"owner": "theowner",
"repoName": "some/repo",
@@ -980,6 +980,20 @@ exports[`api/github mergeBranch(branchName, mergeType) should throw if unknown m
exports[`api/github mergeBranch(branchName, mergeType) should throw if unknown merge type 6`] = `Array []`;
+exports[`api/github setBaseBranch(branchName) sets the base branch 1`] = `
+Array [
+ Array [
+ "repos/some/repo",
+ ],
+ Array [
+ "repos/some/repo/git/refs/heads/master",
+ ],
+ Array [
+ "repos/some/repo/git/refs/heads/some-branch",
+ ],
+]
+`;
+
exports[`api/github updatePr(prNo, title, body) should update the PR 1`] = `
Array [
Array [
diff --git a/test/api/__snapshots__/gitlab.spec.js.snap b/test/api/__snapshots__/gitlab.spec.js.snap
index 55db2da208b0e7227fb07559e845d353bddbdd60..e8dcd147910f133ebbaf6008894a08a53595040e 100644
--- a/test/api/__snapshots__/gitlab.spec.js.snap
+++ b/test/api/__snapshots__/gitlab.spec.js.snap
@@ -203,7 +203,7 @@ Object {
exports[`api/gitlab getFile(filePath, branchName) gets the file with v3 1`] = `
Object {
"apiVersion": "v3",
- "defaultBranch": undefined,
+ "baseBranch": undefined,
"email": undefined,
"repoName": "some-repo",
}
@@ -298,7 +298,7 @@ Array [
exports[`api/gitlab initRepo should initialise the config for the repo - 0 2`] = `
Object {
"apiVersion": "v3",
- "defaultBranch": "master",
+ "baseBranch": "master",
"email": "a@b.com",
"repoName": "some%2Frepo",
}
@@ -321,7 +321,7 @@ Array [
exports[`api/gitlab initRepo should initialise the config for the repo - 1 2`] = `
Object {
"apiVersion": "v3",
- "defaultBranch": "master",
+ "baseBranch": "master",
"email": "a@b.com",
"repoName": "some%2Frepo",
}
@@ -344,7 +344,7 @@ Array [
exports[`api/gitlab initRepo should initialise the config for the repo - 2 2`] = `
Object {
"apiVersion": "v3",
- "defaultBranch": "master",
+ "baseBranch": "master",
"email": "a@b.com",
"repoName": "some%2Frepo",
}
@@ -353,7 +353,7 @@ Object {
exports[`api/gitlab initRepo should use api v4 1`] = `
Object {
"apiVersion": "v4",
- "defaultBranch": "master",
+ "baseBranch": "master",
"email": "a@b.com",
"repoName": "some%2Frepo",
}
@@ -362,8 +362,22 @@ Object {
exports[`api/gitlab initRepo uses provided logger 1`] = `
Object {
"apiVersion": "v3",
- "defaultBranch": "master",
+ "baseBranch": "master",
"email": "a@b.com",
"repoName": "some%2Frepo",
}
`;
+
+exports[`api/gitlab setBaseBranch(branchName) sets the base branch 1`] = `
+Array [
+ Array [
+ "projects/owned",
+ ],
+ Array [
+ "projects/some%2Frepo",
+ ],
+ Array [
+ "user",
+ ],
+]
+`;
diff --git a/test/api/github.spec.js b/test/api/github.spec.js
index 7c59e8722c64d4d77a064c39d302c5ddecdc7552..0a3d03a6299deda3c8a79e856169c476c202f462 100644
--- a/test/api/github.spec.js
+++ b/test/api/github.spec.js
@@ -297,6 +297,21 @@ describe('api/github', () => {
expect(config).toMatchSnapshot();
});
});
+ describe('setBaseBranch(branchName)', () => {
+ it('sets the base branch', async () => {
+ await initRepo('some/repo', 'token');
+ // getBranchCommit
+ ghGot.mockImplementationOnce(() => ({
+ body: {
+ object: {
+ sha: '1238',
+ },
+ },
+ }));
+ await github.setBaseBranch('some-branch');
+ expect(ghGot.mock.calls).toMatchSnapshot();
+ });
+ });
describe('findFilePaths(fileName)', () => {
it('should return empty array if none found', async () => {
await initRepo('some/repo', 'token');
diff --git a/test/api/gitlab.spec.js b/test/api/gitlab.spec.js
index 7f5c52067968430026a23c6e0bf86f16969c9d7e..4c50e94631c1c3f5043c4f7c6e50029205951b84 100644
--- a/test/api/gitlab.spec.js
+++ b/test/api/gitlab.spec.js
@@ -175,6 +175,21 @@ describe('api/gitlab', () => {
expect(config).toMatchSnapshot();
});
});
+ describe('setBaseBranch(branchName)', () => {
+ it('sets the base branch', async () => {
+ await initRepo('some/repo', 'token');
+ // getBranchCommit
+ glGot.mockImplementationOnce(() => ({
+ body: {
+ object: {
+ sha: '1238',
+ },
+ },
+ }));
+ await gitlab.setBaseBranch('some-branch');
+ expect(glGot.mock.calls).toMatchSnapshot();
+ });
+ });
describe('findFilePaths(fileName)', () => {
it('should return empty array', async () => {
await initRepo('some/repo', 'token');
diff --git a/test/workers/repository/__snapshots__/onboarding.spec.js.snap b/test/workers/repository/__snapshots__/onboarding.spec.js.snap
index 1e4ad2bd007f21c5a99618b9b69ca3524df1db8e..e454aab0f030a82412392a9b2c8224c254c7a2d1 100644
--- a/test/workers/repository/__snapshots__/onboarding.spec.js.snap
+++ b/test/workers/repository/__snapshots__/onboarding.spec.js.snap
@@ -50,6 +50,8 @@ This is an onboarding PR to help you understand and configure Renovate before an
---
+You have configured renovate to use branch \`next\` as base branch.
+
It looks like your repository dependencies are already up-to-date and no initial Pull Requests will be necessary.
Would you like to change this? Simply edit the \`renovate.json\` in this branch and Renovate will update this Pull Request description the next time it runs.
diff --git a/test/workers/repository/index.spec.js b/test/workers/repository/index.spec.js
index f053f01a7833393643a2218d52a93451d5c02435..5ce2f9d9fc33a2d93e44d58e9f2924478f399c3e 100644
--- a/test/workers/repository/index.spec.js
+++ b/test/workers/repository/index.spec.js
@@ -23,6 +23,8 @@ describe('workers/repository', () => {
config = {
api: {
getFileJson: jest.fn(),
+ setBaseBranch: jest.fn(),
+ branchExists: jest.fn(),
},
logger,
packageFiles: [],
@@ -33,6 +35,24 @@ describe('workers/repository', () => {
await repositoryWorker.renovateRepository(config);
expect(apis.detectPackageFiles.mock.calls.length).toBe(0);
});
+ it('sets custom base branch', async () => {
+ config.baseBranch = 'some-branch';
+ config.api.branchExists.mockReturnValueOnce(true);
+ apis.detectPackageFiles.mockImplementationOnce(input =>
+ Object.assign(input, { packageFiles: [] })
+ );
+ await repositoryWorker.renovateRepository(config);
+ expect(config.api.setBaseBranch.mock.calls).toHaveLength(1);
+ });
+ it('errors when missing custom base branch', async () => {
+ config.baseBranch = 'some-branch';
+ config.api.branchExists.mockReturnValueOnce(false);
+ apis.detectPackageFiles.mockImplementationOnce(input =>
+ Object.assign(input, { packageFiles: [] })
+ );
+ await repositoryWorker.renovateRepository(config);
+ expect(config.api.setBaseBranch.mock.calls).toHaveLength(0);
+ });
it('skips repository if no package.json', async () => {
apis.detectPackageFiles.mockImplementationOnce(input =>
Object.assign(input, { packageFiles: [] })
diff --git a/test/workers/repository/onboarding.spec.js b/test/workers/repository/onboarding.spec.js
index 28ba2a1ea60854283cd4a0816a90a16c11aa34c6..f02eb610835d2e95dd8ac1d056b210918e814777 100644
--- a/test/workers/repository/onboarding.spec.js
+++ b/test/workers/repository/onboarding.spec.js
@@ -20,6 +20,7 @@ describe('lib/workers/repository/onboarding', () => {
branchUpgrades = {};
});
it('creates pr', async () => {
+ config.baseBranch = 'next';
await onboarding.ensurePr(config, branchUpgrades);
expect(config.api.createPr.mock.calls.length).toBe(1);
expect(config.api.updatePr.mock.calls.length).toBe(0);
diff --git a/yarn.lock b/yarn.lock
index da3b1907a02ef97f0006da1791adb3be9c2d065d..15ad228332c3847ffe9b08ec92956ff7a13e0495 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -832,13 +832,13 @@ dateformat@^1.0.11:
get-stdin "^4.0.1"
meow "^3.3.0"
-debug@2, debug@^2.1.1, debug@^2.2.0, debug@^2.6.3, debug@^2.6.8:
+debug@2, debug@^2.2.0, debug@^2.6.3, debug@^2.6.8:
version "2.6.8"
resolved "https://registry.yarnpkg.com/debug/-/debug-2.6.8.tgz#e731531ca2ede27d188222427da17821d68ff4fc"
dependencies:
ms "2.0.0"
-debug@2.2.0:
+debug@2.2.0, debug@^2.1.1:
version "2.2.0"
resolved "https://registry.yarnpkg.com/debug/-/debug-2.2.0.tgz#f87057e995b1a1f6ae6a4960664137bc56f039da"
dependencies: