XML Report Install Instructions Should Mention manifest.json steps

[danielle-mustillo]

Expected behavior

XML Reporting plugin should be used in projects after completing the installation instructions & configuration instructions.

Actual behavior

The XML plugin is not invoked unless you also add the xml-plugin to the projects manifest.json file. Given a lot of users will be in a similiar situation as I am, where the manifest was generated automatically in the Getting Started instructions, they may be unaware of that additional step.

For the record, a valid manifest.json would invoke this plugin would look like this:

{
  "Language": "go",
  "Plugins": [
    "html-report", "xml-report"
  ]
}

This plugin is very useful for CI and is likely going to be one of the first any user installs.

I don't think the html plugin has any instructions like this, but I also believe that it is included by default. So although this issue applies to that plugin as well, it is less concerning.

Gauge version

Applies to version 1.0.8 and 1.1.6, but I suspect would apply to any version of Gauge. 

If you agree this is an issue, I will be happy to create a pull request describing what users would need to do.

[zabil]

@danielle-mustillo there is a section about reporting plugins https://docs.gauge.org/plugin.html?os=macos&language=python&ide=vscode#reporting-plugins which takes about how to install the xml-report plugin. The best way would be to install the plugin using gauge install xml-report which updates the manifest.json.

[danielle-mustillo]

@zabil Oh ok it was a misunderstanding on my part.
Our environment is slightly different, we run gauge completely within a docker container that comes with the xml-reporting component preinstalled. So by the time we checkout the repository with our gauge definitions, its "too late" for us.
We don't even run gauge locally on our local environment since we use the docker image for everything.
I'm not sure if there is documentation covering such a use case or even if its worth covering such a usecase, but that explains why my manifest didn't get updated.
I'd be OK with closing this issue if you don't think any action is required.

[sriv]

I think that is a valid use case since xml-report is mostly used in CI env rather than in local.

@danielle-mustillo - would you be interested in raising a PR with steps that you'd like ? Happy to review and merge.

You can raise it against https://github.com/getgauge/docs.getgauge.org.

Thanks!

[danielle-mustillo]

@sriv Sure thing, I can write something up. I'll link back to this issue in that issue.

Just to be sure, you mean raise it against https://github.com/getgauge/gauge , right? Since the link you sent me above goes to a 404 page.

[zabil]

I think it's meant to be https://github.com/getgauge/docs.gauge.org