Support to create docs with the plugin

[danijelst]

This is a request for an improvement of the current maven plugin.

So far only validate and run commands of Gauge are support. It would be great if also the command "docs" would be supported, so that the documentation could be generated out of the specs by executing mvn site

[BugDiver]

@danijelst This looks a good feature to have.
Just curious to know when you say docs are you referring to java docs or spectacle plugin docs ?

[danijelst]

@BugDiver yes with "docs" I ment the gauge spectacle documenation.

[BugDiver]

@danijelst Thanks for the clarification.
You can always create a PR for the same. We would be happy to help you out if you need any help.
You can get some idea from PR #42 which add support for validate.

Adding @getgauge/core to get more thoughts on it.

[ajoecker]

if someone can help me with how to add a test case for it, I gladly can open a PR for this.

I use the same mechanism as for the existing TestCases, namely lookupMojo to get my mojo, but this fails with

org.codehaus.plexus.component.repository.exception.ComponentLookupException: java.util.NoSuchElementException
      role: org.apache.maven.plugin.Mojo
  roleHint: com.thoughtworks.gauge.maven:gauge-maven-plugin:1.4.2:docs

I cannot find any configuration allowing me to add it to the test-harness...

[nehashri]

@danijelst For more information, I would like to know why you need the docs command to be supported through mvn. As far as I see, to generate the Gauge docs, there is no need to actually involve the language runner. Irrespective of the language, Gauge can generate the docs. mvn command is not really needed here as we are not really need the Java code to generate the docs.

My questions are around, what value is this command going to add? Is there any specific reason why the Gauge command cannot be used here?

[danijelst]

@nehashri sure it can be done via Gauge command directly, so all of other commands as well. But as there is a maven plugin we also would like to use it and build the documentation from within out source. As we have choosen maven for our builds, it is helpful to have this command to get also the test documents directly with the maven plugin.

[haroon-sheikh]

I would recommend, we do not add this into the maven plugin. Spectacle is a documentation plugin and does not require maven/language runner for it.