Skip to content

Citrus-Maven-Plugin: Documentation differs from actual implementation #1

@svettwer

Description

@svettwer

Moved from citrusframework/citrus#452

Citrus Version Tested with 2.7.6 and 2.8.0-SNAPSHOT

According to the official documentation the Citrus-Maven-Plugin should have 4 goals.

image

The actual implementation of the plugin has not only more goals, but some of the goals mentioned in the documentation are (not long) part of the plugin.

[INFO] citrus-maven-plugin 2.7.6
  Citrus Maven Plugin

This plugin has 5 goals:

citrus:create-docs
  Creates test documentation in interactive mode. Either uses mode excel for MS
  Excel output or html for HTML web page output.

citrus:create-test
  Creates new Citrus test cases with empty XML test file and executable Java
  class. Mojo offers an interactive mode, where the plugin prompts for
  parameters during execution.

citrus:generate-docs
  Generates test overview documentation based on plugin configuration. Html
  documentation creates a web page that contains a list of all available tests
  with meta information. Excel documentation creates a table of all available
  tests with meta information such as name, author, status and so on.

citrus:generate-tests

citrus:help
  Display help information on citrus-maven-plugin.
  Call mvn citrus:help -Ddetail=true -Dgoal=<goal-name> to display parameter
  details.

I am not sure whether or not this is the right place for this issue, since there is also a repository for the citrus website. Please move the issue if you think it should be located elsewhere.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions