Skip to content

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

License

Notifications You must be signed in to change notification settings

sitture/gauge-inprogress

Folders and files

NameName
Last commit message
Last commit date

Latest commit

b707e85 ยท Mar 15, 2024

History

20 Commits
Feb 23, 2024
Oct 20, 2022
Mar 15, 2024
Jan 4, 2021
Jan 1, 2021
Feb 23, 2024
Dec 30, 2020
Jun 27, 2022
Mar 15, 2024
Mar 15, 2024
Mar 15, 2024
Mar 15, 2024
Mar 15, 2024
Jan 5, 2021

Repository files navigation

gauge-inprogress

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

gauge-inprogress

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.

Gauge Badge

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

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

inprogress comments

When adding inprogress tags to specs, you can add a comment below the tags line starting with the inprogress tag.

Example:

# Customer sign-up

* Go to active admin store

## Customer Sign-up

tags: wip

// wip - reason for marking this as work in progress.

* Sign up a new customer with name "Jann" email "[email protected]" and "password"
* Check if the user "Jann" is logged in
* See items available for purchase.

โš™๏ธ 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_TAGS=wip,inprogress,my-in-progress-tag
IN_PROGRESS_CONSOLE_OUTPUT=true

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