Improve docs on configuring mail notifiers
------------------------------------------
Key: CONTINUUM-1929
URL: http://jira.codehaus.org/browse/CONTINUUM-1929
Project: Continuum
Issue Type: Improvement
Components: Documentation
Affects Versions: 1.2
Reporter: Wendy Smoak
I can't find anything in the docs that talks about the various configuration
options in application.xml for the email notifier.
>From /apps/continuum/WEB-INF/classes/META-INF/plexus/application.xml (below).
>The example configuration here in the comments should be moved to a
>documentation page.
{noformat}
<configuration>
<from-mailbox></from-mailbox>
<from-name></from-name>
<timestamp-format>EEE d MMM yyyy HH:mm:ss Z</timestamp-format>
<!-- Customizable mail subject. Use any combination of literal text, or
state, project, or build attributes. Examples:
"[continuum] BUILD ${state}: ${project.groupId} ${project.name}"
results in "[continuum] BUILD SUCCESSFUL: foo.bar Hello World"
"[continuum] BUILD ${state}: ${project.name} ${project.scmTag}"
results in "[continuum] BUILD SUCCESSFULL: Hello World Branch001"
"[continuum] BUILD ${state}: ${project.name} ${project.version}"
results in "[continuum] BUILD SUCCESSFUL: Hello World 2.1-SNAPSHOT
"
"[continuum] BUILD ${state}: ${project.name} ${build.durationTime}"
results in "[continuum] BUILD SUCCESSFUL: Hello World 2 sec"
<configuration>
<from-mailbox></from-mailbox>
<from-name></from-name>
<timestamp-format>EEE d MMM yyyy HH:mm:ss Z</timestamp-format>
<!-- Customizable mail subject. Use any combination of literal text, or
state, project, or build attributes. Examples:
"[continuum] BUILD ${state}: ${project.groupId} ${project.name}"
results in "[continuum] BUILD SUCCESSFUL: foo.bar Hello World"
"[continuum] BUILD ${state}: ${project.name} ${project.scmTag}"
results in "[continuum] BUILD SUCCESSFULL: Hello World Branch001"
"[continuum] BUILD ${state}: ${project.name} ${project.version}"
results in "[continuum] BUILD SUCCESSFUL: Hello World 2.1-SNAPSHOT
"
"[continuum] BUILD ${state}: ${project.name} ${build.durationTime}"
results in "[continuum] BUILD SUCCESSFUL: Hello World 2 sec"
"[continuum] BUILD ${state}: ${project.name}, Build Def -
${build.buildDefinition.description}"
results in "[continuum] BUILD SUCCESSFUL: Hello World, Build Def
- Nightly Test Build"
-->
<subject-format>[continuum] BUILD ${state}:
${project.projectGroup.name} - ${project.name} -
${build.buildDefinition.description}</subject-format>
<includeBuildResult>true</includeBuildResult>
<includeBuildSummary>true</includeBuildSummary>
<includeTestSummary>true</includeTestSummary>
<includeOutput>false</includeOutput>
<alwaysSend>false</alwaysSend>
</configuration>
</component>
{noformat}
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
