`allowed-tags`

Only lets you use tags from a list you decide on.

What it does

Teams often agree on a small set of tags. Once you write that set down here, a mistyped or made-up tag is caught straight away instead of quietly doing nothing.

Turning it on

Add this to your .gurkencheckrc:

{
  "allowed-tags": ["on", {
    "tags": ["@wip", "@smoke"],
    "patterns": ["^@issue-\\d+$"]
  }]
}

Settings

Setting	Value	If you leave it out	What it does
`tags`	list of tag names	`empty list`	Tags that are allowed, written exactly as they appear in the file.
`patterns`	list of regular expressions	`empty list`	A tag is allowed when it matches any of these. Use this for tags with numbers in them, such as ticket references.

Examples

Passes

@smoke @issue-42
Feature: Logging in

  Scenario: A known user logs in
    Given I am a known user
    When I log in
    Then I see my dashboard

Fails

@smoek
Feature: Logging in

  Scenario: A known user logs in
    Given I am a known user
    When I log in
    Then I see my dashboard

gurkencheck reports: Not allowed tag @smoek on Feature