sirius:generate

Full name:

com.github.mkolisnyk:sirius-maven-plugin:1.2-SNAPSHOT:generate

Description:

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.

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: generate-sources.

Optional Parameters

Name Type Since Description
groups String - The semi-colon separated list of labels which can be used as filter while quering issues. If multiple values are specified the issues returned should have at least one of the specified labels.
Default value is: Test.
User property is: issueget.groups.
outputLocation String - The folder where output should be produced to
Default value is: ..
User property is: issueget.output.
outputType String - Identifies the output type to be produced. At the moment the following values are supported:
  • trace - the output is the traceability matrix in a GitHub Wiki markdown format
  • mvn-trace - the output is the traceability matrix in HTML format
  • cucumber - the output is the feature files containing the issues description

Default value is: trace.
User property is: issueget.type.
password String - The password to connect to GitHub repository
User property is: issueget.password.
repository String - The GitHub repository name to retrieve issues for
Default value is: Sirius.
User property is: issueget.repository.
userName String - The user name to connect to GitHub repository with
User property is: issueget.user.

Parameter Details

groups:

The semi-colon separated list of labels which can be used as filter while quering issues. If multiple values are specified the issues returned should have at least one of the specified labels.
  • Type: java.lang.String
  • Required: No
  • User Property: issueget.groups
  • Default: Test

outputLocation:

The folder where output should be produced to
  • Type: java.lang.String
  • Required: No
  • User Property: issueget.output
  • Default: .

outputType:

Identifies the output type to be produced. At the moment the following values are supported:
  • trace - the output is the traceability matrix in a GitHub Wiki markdown format
  • mvn-trace - the output is the traceability matrix in HTML format
  • cucumber - the output is the feature files containing the issues description
  • Type: java.lang.String
  • Required: No
  • User Property: issueget.type
  • Default: trace

password:

The password to connect to GitHub repository
  • Type: java.lang.String
  • Required: No
  • User Property: issueget.password

repository:

The GitHub repository name to retrieve issues for
  • Type: java.lang.String
  • Required: No
  • User Property: issueget.repository
  • Default: Sirius

userName:

The user name to connect to GitHub repository with
  • Type: java.lang.String
  • Required: No
  • User Property: issueget.user