gauge-inprogress

README

gauge-inprogress

A Gauge plugin to keep track of specs/scenarios that are marked with work in progress (wip) tags.

The aim of this plugin is to make sure that any specs or scenarios tagged with in-progress or wip tags are trackable. And all scenarios marked as in-progress tags are followed by a reason so that it's easy to revisit these accordingly.

All notable changes to this project are documented in CHANGELOG.md. The format is based on Keep a Changelog and adheres to Semantic Versioning.

⚒ Installation

• Install the plugin

gauge install inprogress

Offline installation

• Download the plugin from Releases

gauge install inprogress --file inprogress-${version}.zip

Using the plugin

Change to to your project's root directory.

gauge docs inprogress /absolute/path/to/specs

The report file will be generated under reports/inprogress.md

⚙ Configuration

You can also set/add the following configuration to your projects env file. env/default/default.properties

• IN_PROGRESS_TAGS - This is a comma separated list of tags to use for analysing inprogress scenarios. Default is set to wip,in-progress
• IN_PROGRESS_CONSOLE_OUTPUT - When set to true it should output the scenarios to console output.

Examples:

IN_PROGRESS_CONSOLE_OUTPUT=true
IN_PROGRESS_TAGS=wip,inprogress,my-in-progress-tag

Building locally

go run build/make.go
go run build/make.go --install

👋 Issues & Contributions

Please open an issue here on GitHub if you have a problem, suggestion, or other comments.

Pull requests are welcome and encouraged! Any contributions should include new or updated tests as necessary to maintain thorough test coverage.

📜 License

This work is licensed under the terms of GNU Public License version 3.0