citrusframework / citrusframework/citrus-website
Citrus-Maven-Plugin: Documentation differs from actual implementation
- Dominant language
- HTML
- Stars
- 0
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
Moved from https://github.com/citrusframework/citrus/issues/452
---------
**Citrus Version** Tested with 2.7.6 and 2.8.0-SNAPSHOT
According to the [official documentation](https://citrusframework.org/docs/maven-plugin/) the Citrus-Maven-Plugin should have 4 goals.

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= 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.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the Citrus Maven Plugin documentation page linked in the issue and compare its listed goals with the Maven output shown for versions 2.7.6 and 2.8.0-SNAPSHOT. Update the documentation to reflect the actual plugin goals and verify that the descriptions match the implementation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100