Package dev.galasa.githubissue

Annotation Interface GitHubIssue

@Retention(RUNTIME)
@Target({METHOD,TYPE})
public @interface GitHubIssue

This annotation will cause the Manager to influence the "failed" result of the test based on whether a GitHub issue is open or closed.

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	issue	The issue to check against

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	githubId	The CPS id of the GitHub instance, be it public GitHub or an enterprise instance
String[]	regex	One or more REGEX strings to check in the failing exception, if any of them match, then this annotation is valid and therefore GitHub will be checked.
String	repository	The repository to look for the issue, if not provided, will use the default from the CPS

Element Details

issue

String issue

The issue to check against

repository

String repository

The repository to look for the issue, if not provided, will use the default from the CPS

Default:

""

githubId

String githubId

The CPS id of the GitHub instance, be it public GitHub or an enterprise instance

Default:

"DEFAULT"

regex

String[] regex

One or more REGEX strings to check in the failing exception, if any of them match, then this annotation is valid and therefore GitHub will be checked. If no REGEX is provided, any failure is valid.

Default:

{}