Le blog

Une des fonctionnalités de JIRA consiste en l'export d'un ensemble de demandes JIRA sous forme d'un fichier Excel. Cependant ce fichier ne contient pas les commentaires. En effet les données présentes dans l'export sont des champs de la demande JIRA, nous allons donc voir comment concaténer les commentaires dans un champ spécialement créé à cet usage.

 Attention, le besoin d'export des commentaires est rare mais cela peut s'avérer intéressant, par contre l'ajout de ce champ peut conduire à la création d'un fichier volumineux

Création du champ personnalisé

Commençons par créer un champ de type "Calculated Text Field" disponible grâce au plugin JIRA Misc Custom Fields gratuit sur le Marketplace d'Atlassian. Dans la description du champ, ajoutez le code qui permettra de récupérer les commentaires et informations associés pour chaque demande JIRA.

Voici comment le construire :

• Placer le code dans un commentaire HTML  <!-- @@Formula: -->
• Récupérer la liste des commentaires c : commentManager.getComments(issueObject)
• Ajouter un séparateur de votre choix entre les commentaires "\n_____________\n"
• Ajouter les données souhaitées du commentaire :
  • la date c.getCreated()
  • l'auteur du commentaire c.getAuthorApplicationUser()
  • le corps du commentaire c.getBody()

Code du champ Calculated Text Field

<!-- @@Formula:
import com.atlassian.jira.issue.comments.CommentManager;
import org.joda.time.DateTime;
String separator = "";
CommentManager commentManager = com.atlassian.jira.ComponentManager.getComponent(CommentManager.class);
StringBuilder s = new StringBuilder();
for (com.atlassian.jira.issue.comments.Comment c : commentManager.getComments(issueObject)) {
s.append(separator );
separator = "\n____________________\n";
s.append( new DateTime( c.getCreated()).toString("dd/MM/yyyy"));
s.append(", ");
s.append(c.getAuthorApplicationUser().getDisplayName());
s.append(" : \n");
s.append(c.getBody());
}
return s.toString();
-->

Résultat du fichier d'export Excel

Il est conseillé de restreindre ce champ aux seuls projets qui en ont besoin. Pour cela dans l'administration de JIRA modifiez la configuration du champ personnalisé. N'oubliez pas de ré-indexer les données suite à vos modifications afin que celles ci soient disponibles immédiatement.

Sources :

• https://marketplace.atlassian.com/plugins/com.innovalog.jmcf.jira-misc-custom-fields/server/overview
• https://innovalog.atlassian.net/wiki/display/JMCF/JIRA+Misc+Custom+Fields#JIRAMiscCustomFields-calculatedtextfield