Clarify the email texts/subject and make them more consistent

Add the Change-Id and PatchSetId to the change footer. Use
the subject to refer to changes instead of the abbreviated
id.  Make the header section more similar for the different
message types.  Eliminate some redundant urls in footer and
body. Use merge-failed as a message type instead of comment.
Shorten the subject line (project path), remove the change
id from it.

Bug: issue 311
Change-Id: Ia4e616683608e9665ad6f0eaf7433be5edf2ed88
This commit is contained in:
Martin Fick
2010-08-04 17:20:52 -06:00
parent 76d8f4aad0
commit 9afb50af02
9 changed files with 38 additions and 33 deletions

View File

@@ -26,7 +26,7 @@ public class MergeFailSender extends ReplyToChangeSender {
@Inject @Inject
public MergeFailSender(EmailArguments ea, @Assisted Change c) { public MergeFailSender(EmailArguments ea, @Assisted Change c) {
super(ea, c, "comment"); super(ea, c, "merge-failed");
} }
@Override @Override

View File

@@ -32,7 +32,11 @@
## to a change being abandoned. It is a ChangeEmail: see ChangeSubject.vm and ## to a change being abandoned. It is a ChangeEmail: see ChangeSubject.vm and
## ChangeFooter.vm. ## ChangeFooter.vm.
## ##
$fromName has abandoned change $changeId.abbreviate(): $fromName has abandoned this change.
Change subject: $change.subject
......................................................................
#if ($coverLetter) #if ($coverLetter)
$coverLetter $coverLetter

View File

@@ -44,6 +44,8 @@ To unsubscribe, visit $email.settingsUrl
#end #end
Gerrit-MessageType: $messageClass Gerrit-MessageType: $messageClass
Gerrit-Change-Id: $changeId
Gerrit-PatchSet: $patchSet.patchSetId
Gerrit-Project: $projectName Gerrit-Project: $projectName
Gerrit-Branch: $branch.shortName Gerrit-Branch: $branch.shortName
Gerrit-Owner: $email.getNameEmailFor($change.owner) Gerrit-Owner: $email.getNameEmailFor($change.owner)

View File

@@ -34,4 +34,4 @@
#macro(elipses $length $str) #macro(elipses $length $str)
#if($str.length() > $length)${str.substring(0,$length)}...#else$str#end #if($str.length() > $length)${str.substring(0,$length)}...#else$str#end
#end #end
[$branch.shortName] Change $changeId.abbreviate(): ($projectName) #elipses(60, $change.subject) Change in $projectName.replaceAll('/.*/', '...')[$branch.shortName]: #elipses(60, $change.subject)

View File

@@ -33,15 +33,15 @@
## ChangeSubject.vm and ChangeFooter.vm. ## ChangeSubject.vm and ChangeFooter.vm.
## ##
#if ($email.coverLetter || $email.inlineComments) #if ($email.coverLetter || $email.inlineComments)
Comments on Patch Set $patchSet.patchSetId: $fromName has posted comments on this change.
Change subject: $change.subject
......................................................................
#if ($email.coverLetter) #if ($email.coverLetter)
$email.coverLetter $email.coverLetter
#end #end
#if($email.inlineComments)$email.inlineComments#end #if($email.inlineComments)$email.inlineComments#end
#if ($email.changeUrl)
To respond, visit $email.changeUrl
#end
#end #end

View File

@@ -32,8 +32,11 @@
## to a failure upon attempting to merge a change to the head. It is a ## to a failure upon attempting to merge a change to the head. It is a
## ChangeEmail: see ChangeSubject.vm and ChangeFooter.vm. ## ChangeEmail: see ChangeSubject.vm and ChangeFooter.vm.
## ##
Change $change.key.abbreviate()#if ($patchSetInfo.author.name) $fromName has submitted this change and it FAILED to merge.
by $patchSetInfo.author.name#end FAILED to submit to ${change.dest.shortName}.
Change subject: $change.subject
......................................................................
#if ($email.coverLetter) #if ($email.coverLetter)
$email.coverLetter $email.coverLetter

View File

@@ -32,7 +32,13 @@
## a change successfully merged to the head. It is a ChangeEmail: see ## a change successfully merged to the head. It is a ChangeEmail: see
## ChangeSubject.vm and ChangeFooter.vm. ## ChangeSubject.vm and ChangeFooter.vm.
## ##
Change $changeId.abbreviate()#if ($patchSetInfo.author.name) #macro(elipses $length $str)
by $patchSetInfo.author.name#end submitted to $change.dest.shortName: #if($str.length() > $length)${str.substring(0,$length)}...#else$str#end
#end
$fromName has submitted this change and it was merged.
Change subject: $change.subject
......................................................................
$email.changeDetail$email.approvals $email.changeDetail$email.approvals

View File

@@ -32,7 +32,6 @@
## to a user submitting a new change for review. It is a ChangeEmail: see ## to a user submitting a new change for review. It is a ChangeEmail: see
## ChangeSubject.vm and ChangeFooter.vm. ## ChangeSubject.vm and ChangeFooter.vm.
## ##
#set ($destination = "Change $changeId.abbreviate() for $branch.shortName in $projectName:")
#if($email.reviewerNames) #if($email.reviewerNames)
Hello $StringUtils.join($email.reviewerNames, ' ,'), Hello $StringUtils.join($email.reviewerNames, ' ,'),
@@ -40,18 +39,14 @@ I'd like you to do a code review.#if($email.changeUrl) Please visit
$email.changeUrl $email.changeUrl
to review the following change: to review the following change.
#end #end
$destination
#else #else
$destination $fromName has uploaded a new change for review.
#if($email.changeUrl)
$email.changeUrl
#end
#end #end
Change subject: $change.subject
......................................................................
$email.changeDetail $email.changeDetail
git pull ssh://$email.sshHost/$projectName $patchSet.refName git pull ssh://$email.sshHost/$projectName $patchSet.refName

View File

@@ -32,26 +32,21 @@
## related to a user submitting a new patchset for a change. It is a ## related to a user submitting a new patchset for a change. It is a
## ChangeEmail: see ChangeSubject.vm and ChangeFooter.vm. ## ChangeEmail: see ChangeSubject.vm and ChangeFooter.vm.
## ##
#set ($destination = "Change $changeId.abbreviate() (patch set $patchSet.patchSetId) for $branch.shortName in $projectName:")
#if($email.reviewerNames) #if($email.reviewerNames)
Hello $StringUtils.join($email.reviewerNames, ' ,'), Hello $StringUtils.join($email.reviewerNames, ' ,'),
I'd like you to reexamine change ${changeId.abbreviate()}.#if($email.changeUrl) Please visit I'd like you to reexamine a change.#if($email.changeUrl) Please visit
$email.changeUrl $email.changeUrl
to look at patch set $patchSet.patchSetId to look at the new patch set (#$patchSet.patchSetId).
#end #end
$destination
#else #else
$destination $fromName has uploaded a new patch set (#$patchSet.patchSetId).
#if($email.changeUrl)
$email.changeUrl
#end
#end #end
Change subject: $change.subject
......................................................................
$email.changeDetail $email.changeDetail
git pull ssh://$email.sshHost/$projectName $patchSet.refName git pull ssh://$email.sshHost/$projectName $patchSet.refName