agilepathway / gauge-confluence

Publishes Gauge specifications to Confluence. This is a documentation plugin for Gauge.
Apache License 2.0
3 stars 0 forks source link

Remove need for Space config vars in dry run mode #60

Closed johnboyes closed 3 years ago

johnboyes commented 3 years ago

The three config variables which are mandatory for actual publishing (CONFLUENCE_BASE_URL, CONFLUENCE_USERNAME and CONFLUENCE_TOKEN) no longer need to be provided when doing a dry run. This is useful as it means that anyone can run the plugin locally on their own machine in dry run mode (by setting the config variable DRY_RUN to true) to verify that the Gauge specs are publishable (i.e they do not have any duplicates).

johnboyes commented 3 years ago

The reason why the Publish specs to Confluence test environment GitHub actions job failed on this PR is that that GitHub Actions job pulls the latest released version of the Confluence plugin, rather than building the plugin based on the code on this branch. In this particular PR we have removed the space related config vars that were mandatory until now, which is why the latest released version of the Confluence plugin causes a failure. This is only an issue in this particular PR, so is nothing to worry about.

(The reason why we don't build the plugin locally on the Publish specs to Confluence test environment GitHub Actions job is that it we want to make that job as simple as possible so it can be used as a reference for anyone who wants to use the plugin to publish Gauge specs via their own CI/CD pipeline).