test: add documentation to TestGiteaCancelRun

chmouel · chmouel · commit 539e5ea838dd · 2026-03-12T17:27:45.000+01:00
Added a comment to the TestGiteaCancelRun function to clarify the
intended behavior of canceling pipeline runs via Gitea comments.
diff --git a/test/gitea_gitops_commands_test.go b/test/gitea_gitops_commands_test.go
@@ -24,6 +24,7 @@ import (
 	"gotest.tools/v3/assert"
 )
 
+// TestGiteaCancelRun will test that we can cancel a pipelinerun with the /cancel comment and that the pipelinerun is properly marked as cancelled.
 func TestGiteaCancelRun(t *testing.T) {
 	topts := &tgitea.TestOpts{
 		TargetEvent: triggertype.PullRequest.String(),

Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@ import (`
`24`	`24`	`"gotest.tools/v3/assert"`
`25`	`25`	`)`
`26`	`26`
	`27`	`+// TestGiteaCancelRun will test that we can cancel a pipelinerun with the /cancel comment and that the pipelinerun is properly marked as cancelled.`
`27`	`28`	`func TestGiteaCancelRun(t *testing.T) {`
`28`	`29`	`topts := &tgitea.TestOpts{`
`29`	`30`	`TargetEvent: triggertype.PullRequest.String(),`