Introduction

This plugin provides functionality to generate different reports like:

  • Github Wiki Traceability Matrix - the report in GitHub wiki markdown format displaying correspondence between requirements (user stories/milestones) and associated issues (tickets)
  • Maven formatted Traceability Matrix - the Maven reporting goal generating traceability matrix as the part of Maven site phase.
  • Cucumber report - the extension of maven-cucumber-reporting-mojo plugin which generates Cucumber report as the part of Maven site generation
  • Cucumber Usage report - uses artifacts of maven-cucumber-reporting-mojo plugin to generate Cucumber keywords usage information. It is used to analyze the effectiveness of using various Cucumber expressions

Author

Myk Kolisnyk

Build Status

View build congifuration

Sirius-Maven-Plugins

Plugin introduction, description, and other relevant information.

Goals Overview

General Information about the goals.

  • sirius:cucumber Yes Generates Cucumber HTML detailed report based on execution results
  • sirius:cucumber-usage Yes Generates HTML report based on Cucumber usage page. The input is the result of the site:cucumber goal which is the part of this plugin
  • sirius:generate No Generates various output based on issues information in the GitHub. At the moment it has options to get the output in a form of Cucumber features or GitHub Wiki page with traceability matrix.
  • sirius:help No Display help information on sirius-maven-plugin. Call mvn sirius:help -Ddetail=true -Dgoal=goal-name to display parameter details.
  • sirius:trace Yes No description.

Usage

General instructions on how to use the Plugin Name can be found on the usage page. Some more specific use cases are described in the examples given below. Last but not least, users occasionally contribute additional examples, tips or errata to the plugin's wiki page.

In case you still have questions regarding the plugin's usage, please have a look at the FAQ and feel free to contact the user mailing list. The posts to the mailing list are archived and could already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching the mail archive.

If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our issue tracker. When creating a new issue, please provide a comprehensive description of your concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason, entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated. Of course, patches are welcome, too. Contributors can check out the project from our source repository and will find supplementary information in the guide to helping with Maven.

Examples

To provide you with better understanding on some usages of the Plugin Name, you can take a look into the following examples: