Skip to main content

Configuration

To enable manual testing a .testspace.yml configuration file is required to be placed at the root of your repo, for example:

root
โ”œโ”€โ”€ README.md
โ”œโ”€โ”€ .testspace.yml
โ””โ”€โ”€ specs
..

Manual#

At the minimum the .testspace.yml content should be:

manual:

Note without the .testspace.yml file specs will not be visible in Testspace

The full .testspace.yml configuration format is:

manual:
path: "/path/to/thespecs" # optional path to specs root, defaults to "specs"
board: # optional
release: # optional one or more branch-wildcard entries, defaults to "sandbox*"

path#

The path represents the root folder for spec files. It the path is omitted, the root defaults to specs.

manual:
path: "/path/to/thespecs" # optional path to specs root, defaults to "specs"

board#

To enable a GitHub Project Board the keyword board: is required.

manual:
board:

Release#

Testspace can be customized to manage "non" default branches as release branches, preventing the sandbox attribute from being enabled.

release: # optional one or more branch-wildcard entries

The Sandbox setting enabled controls the following behavior:

  • Push New Issue is disabled
  • Email notifications are disabled
  • The Space not shown in the Organization view
  • The Space results are excluded from the Project Insights

Note that a branch used in an open Pull Request will result in its sandbox attribute automatically disabled.

Example#

Using a pattern to define release branches (i.e. 46_release):

release:
- *_release