Merge pull request #138 from redhat-appstudio/pr/kind-its

Add kind annotation to IntegrationTestScenario
konflux-ci · Oct 16, 2023 · 7e4e499 · 7e4e499
2 parents 54af35c + 0457e50
commit 7e4e499
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/book/integration-service.md b/book/integration-service.md
@@ -131,6 +131,7 @@ Following the [annotation guidelines](https://docs.google.com/document/d/1gyXM3p
 “pipelines.appstudio.openshift.io/type": "test",
 "test.appstudio.openshift.io/test":      “<component|composite>”
 “test.appstudio.openshift.io/scenario":  “<IntegrationTestScenario name>”
+“test.appstudio.openshift.io/kind":      “<enterprise-contract|...>”
 "appstudio.openshift.io/snapshot":       “<snapshot name>”
 “appstudio.openshift.io/component":      “<component name>”
 “appstudio.openshift.io/application":    “<Application name>”
@@ -143,6 +144,8 @@ The "test.appstudio.openshift.io/optional" Label provides users an option whethe
 ```
 The label will be copied to the subsequent Test PipelineRuns.
 
+The `test.appstudio.openshift.io/kind` annotation is an optional annotation that can be used to filter on the kinds of `IntegrationTestScenario`s. The first recognized kind is the `enterprise-contract`. It will be copied to the `PipelineRun`s resulting from the `IntegrationTestScenario`.
+
 #### Workspace
 
 The Integration service will provide Tekton workspaces to the individual PipelineRuns to supply additional resources required for testing, such as secure credentials for accessing test Environments.