Allow customization of commit messages & pull requests

[tusbar]

Hi,

It would be nice to have a way to customize a few things:

• commit messages / pull requests names (through templating maybe)
• pull requests labels (I use a dependency label for all that stuff)

[finnp]

Hey @tusbar,

your second request is actually already possible. Just add this to the package.json of your project and we will use your dependency label instead of greenkeeper:

"greenkeeper": {
   "label": "dependency"
}

We are probably also going to add support for commit message / pull request name customisation.

[danielnbarbosa]

any thoughts on whether this feature will be added? would be very helpful for us as we need to track all changes through pivotal tracker and customizing the commit message would allow us to automate this process instead of manually updating the merge message.

[finnp]

@danielnbarbosa Hey, it might still need some time, but I'm fairly sure we will be adding this feature. ☺️

[danielnbarbosa]

thanks @finnp. looking forward to it!

[Arcanemagus]

I was looking into this and here's what I found. I'm sure I've probably missed a location where commit messages are created, but I wanted to get the conversation started here.

From what I found there are five locations where commit messages are created.

This is where a "pin" commit is created when a build has failed and GK is attempting to pin a previous version.

greenkeeper/lib/open-issue.js

Line 75 in e3b2ec2

message: `${dependencyType === 'devDependencies' ? 'chore' : 'fix'}: pin ${dependency} to ${oldVersionResolved}`

Here is where the normal upgrade commits are created.

greenkeeper/jobs/create-version-branch.js

Lines 140 to 151 in e3b2ec2

	const commitMessageScope = !satisfies && type === 'dependencies'
	? 'fix'
	: 'chore'
	let commitMessage = `${commitMessageScope}(package): update ${dependency} to version ${version}`
	if (!satisfies && openPR) {
	await upsert(repositories, openPR._id, {
	comments: [...(openPR.comments || []), version]
	})
	commitMessage += `\n\nCloses #${openPR.number}`
	}

As well as 3 potential commits within the initial branch creation.

greenkeeper/jobs/create-initial-branch.js

Line 156 in e3b2ec2

message: 'chore(package): update dependencies',

greenkeeper/jobs/create-initial-branch.js

Line 171 in e3b2ec2

message: 'chore(travis): whitelist greenkeeper branches',

greenkeeper/jobs/create-initial-branch.js

Line 177 in e3b2ec2

message: 'docs(readme): add Greenkeeper badge',

In order to support commit message formats other than Angular, I'm currently thinking of something along these lines in package.json:

{
  "greenkeeper": {
    "commitMessages": {
      "initialBadge": "docs(readme): add Greenkeeper badge",
      "initialDependencies": "chore(package): update dependencies",
      "initialBranches": "chore(travis): whitelist greenkeeper branches",
      "dependencyUpdate": "fix(package): update ${dependency} to version ${version}",
      "devDependencyUpdate": "chore(package): update ${dependency} to version ${version}",
      "dependencyPin" : "fix: pin ${dependency} to ${oldVersionResolved}",
      "devDependencyPin": "chore: pin ${dependency} to ${oldVersionResolved}",
      "closes": "\n\nCloses #${number}"
  }
}

There are a couple of different ways this could be done, since the last 5 require some form of templating already it might be possible to combine the two dependency types together, but that might limit some commit message styles. The templating style also of course can be changed, right now it is a direct clone of the JS strings.

Am I missing some strings?
Is there a better way to accomplish this?