Add function documentation

Signed-off-by: TannerGabriel <gabrieltanner.code@gmail.com>
keptn-contrib · Aug 31, 2022 · 0ebf3a9 · 0ebf3a9
1 parent 8042a26
commit 0ebf3a9
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -35,7 +35,7 @@ running in the Keptn ecosystem:
 |    0.16.x     |                               keptncontrib/job-executor-service:0.2.3                                |       v2       |
 |    0.16.x     |                               keptncontrib/job-executor-service:0.2.4                                |       v2       |
 |    0.17.x     |                               keptncontrib/job-executor-service:0.2.5                                |       v2       |
-|    0.18.x     |                               keptncontrib/job-executor-service:0.2.6                                |       v2       |
+|    0.18.x     |                               keptncontrib/job-executor-service:0.3.0                                |       v2       |
 
 **Please Note**:
 - Newer Keptn versions might be compatible, but compatibility has not been verified at the time of the release.

diff --git a/pkg/eventhandler/eventhandlers.go b/pkg/eventhandler/eventhandlers.go
@@ -294,6 +294,7 @@ func sendJobFailedEvent(myKeptn *keptnv2.Keptn, jobName string, serviceName stri
 	}
 }
 
+// getTaskFinishedEvent returns the finished data for the received event as an interface which can be directly returned using the go-sdk
 func getTaskFinishedEvent(event sdk.KeptnEvent, receivedEventData keptn.EventProperties, jobLogs []jobLogs, data dataForFinishedEvent) interface{} {
 	var logMessage strings.Builder