enhance(pipeline): add ruledata options to various pipeline calls

go.mod

@@ -6,7 +6,7 @@ require (
 	github.com/buildkite/yaml v0.0.0-20230306222819-0e4e032d4835
 	github.com/coreos/go-semver v0.3.1
 	github.com/gin-gonic/gin v1.9.1
-	github.com/go-vela/server v0.23.4-0.20240401175144-f591935d2fc9
+	github.com/go-vela/server v0.23.4-0.20240405160933-fb31ea5a6e96
 	github.com/go-vela/types v0.23.4-0.20240402153726-f16c3e4cb5fb
 	github.com/golang-jwt/jwt/v5 v5.2.1
 	github.com/google/go-cmp v0.6.0

go.sum

@@ -30,8 +30,8 @@ github.com/go-playground/universal-translator v0.18.1 h1:Bcnm0ZwsGyWbCzImXv+pAJn
 github.com/go-playground/universal-translator v0.18.1/go.mod h1:xekY+UJKNuX9WP91TpwSH2VMlDf28Uj24BCp08ZFTUY=
 github.com/go-playground/validator/v10 v10.14.0 h1:vgvQWe3XCz3gIeFDm/HnTIbj6UGmg/+t63MyGU2n5js=
 github.com/go-playground/validator/v10 v10.14.0/go.mod h1:9iXMNT7sEkjXb0I+enO7QXmzG6QCsPWY4zveKFVRSyU=
-github.com/go-vela/server v0.23.4-0.20240401175144-f591935d2fc9 h1:R3TxguOk3JsIRoZn0oQBTLZRDIj4Xpeon+L/YJOF2Vw=
-github.com/go-vela/server v0.23.4-0.20240401175144-f591935d2fc9/go.mod h1:Rbe6vgYe3gao8sBcALlhrM2YH4yu2cxJAFpWdDUbdZY=
+github.com/go-vela/server v0.23.4-0.20240405160933-fb31ea5a6e96 h1:MI0NwjyqvRBXaTY8mlE5EeDTZ4k3zeaL6hJJBxgE7TA=
+github.com/go-vela/server v0.23.4-0.20240405160933-fb31ea5a6e96/go.mod h1:Rbe6vgYe3gao8sBcALlhrM2YH4yu2cxJAFpWdDUbdZY=
 github.com/go-vela/types v0.23.4-0.20240402153726-f16c3e4cb5fb h1:jHao/NNRswInMLEb0m1OJ84d1m/LGWMCmaeRqSDnWQY=
 github.com/go-vela/types v0.23.4-0.20240402153726-f16c3e4cb5fb/go.mod h1:mEF9dLkk00rUXf/t39n2WvXZgJbxnPEEWy+DHqIlRUo=
 github.com/goccy/go-json v0.10.2 h1:CrxCmQqYDkv1z7lO7Wbh2HN93uovUHgrECaO5ZrCXAU=

vela/pipeline.go

@@ -22,6 +22,16 @@ type PipelineOptions struct {
 	//
 	// Default: yaml
 	Output string `url:"output,omitempty"`
+
+	// Ruledata options
+	Branch  string   `url:"branch,omitempty"`
+	Comment string   `url:"comment,omitempty"`
+	Event   string   `url:"event,omitempty"`
+	Repo    string   `url:"repo,omitempty"`
+	Status  string   `url:"status,omitempty"`
+	Tag     string   `url:"tag,omitempty"`
+	Target  string   `url:"target,omitempty"`
+	Path    []string `url:"path,omitempty"`
 }
 
 // Get returns the provided pipeline.

vela/pipeline_test.go

@@ -531,7 +531,7 @@ func ExamplePipelineService_Compile() {
 	// Set new token in existing client
 	c.Authentication.SetPersonalAccessTokenAuth("token")
 
-	// create options for pipeline call
+	// create default options for pipeline call
 	opts := &PipelineOptions{
 		Output: "yaml", // default
 	}
@@ -543,6 +543,27 @@ func ExamplePipelineService_Compile() {
 	}
 
 	fmt.Printf("Received response code %d, for pipeline %+v", resp.StatusCode, pipeline)
+
+	// create ruledata options for pipeline call
+	opts = &PipelineOptions{
+		Output:  "yaml", // default
+		Branch:  "main",
+		Comment: "comment",
+		Event:   "push",
+		Repo:    "octocat",
+		Status:  "success",
+		Tag:     "v1.0.0",
+		Target:  "production",
+		Path:    []string{"path/to/file", "README.md"},
+	}
+
+	// compile a pipeline from a repo from the server
+	pipeline, resp, err = c.Pipeline.Compile("github", "octocat", "48afb5bdc41ad69bf22588491333f7cf71135163", opts)
+	if err != nil {
+		fmt.Println(err)
+	}
+
+	fmt.Printf("Received response code %d, for pipeline %+v", resp.StatusCode, pipeline)
 }
 
 func ExamplePipelineService_Expand() {
@@ -564,6 +585,27 @@ func ExamplePipelineService_Expand() {
 	}
 
 	fmt.Printf("Received response code %d, for pipeline %+v", resp.StatusCode, pipeline)
+
+	// create ruledata options for pipeline call
+	opts = &PipelineOptions{
+		Output:  "yaml", // default
+		Branch:  "main",
+		Comment: "comment",
+		Event:   "push",
+		Repo:    "octocat",
+		Status:  "success",
+		Tag:     "v1.0.0",
+		Target:  "production",
+		Path:    []string{"path/to/file", "README.md"},
+	}
+
+	// compile a pipeline from a repo from the server
+	pipeline, resp, err = c.Pipeline.Expand("github", "octocat", "48afb5bdc41ad69bf22588491333f7cf71135163", opts)
+	if err != nil {
+		fmt.Println(err)
+	}
+
+	fmt.Printf("Received response code %d, for pipeline %+v", resp.StatusCode, pipeline)
 }
 
 func ExamplePipelineService_Templates() {
@@ -585,6 +627,27 @@ func ExamplePipelineService_Templates() {
 	}
 
 	fmt.Printf("Received response code %d, for pipeline %+v", resp.StatusCode, pipeline)
+
+	// create ruledata options for pipeline call
+	opts = &PipelineOptions{
+		Output:  "yaml", // default
+		Branch:  "main",
+		Comment: "comment",
+		Event:   "push",
+		Repo:    "octocat",
+		Status:  "success",
+		Tag:     "v1.0.0",
+		Target:  "production",
+		Path:    []string{"path/to/file", "README.md"},
+	}
+
+	// compile a pipeline from a repo from the server
+	pipeline, resp, err = c.Pipeline.Templates("github", "octocat", "48afb5bdc41ad69bf22588491333f7cf71135163", opts)
+	if err != nil {
+		fmt.Println(err)
+	}
+
+	fmt.Printf("Received response code %d, for pipeline %+v", resp.StatusCode, pipeline)
 }
 
 func ExamplePipelineService_Validate() {
@@ -606,4 +669,25 @@ func ExamplePipelineService_Validate() {
 	}
 
 	fmt.Printf("Received response code %d, for pipeline %+v", resp.StatusCode, pipeline)
+
+	// create ruledata options for pipeline call
+	opts = &PipelineOptions{
+		Output:  "yaml", // default
+		Branch:  "main",
+		Comment: "comment",
+		Event:   "push",
+		Repo:    "octocat",
+		Status:  "success",
+		Tag:     "v1.0.0",
+		Target:  "production",
+		Path:    []string{"path/to/file", "README.md"},
+	}
+
+	// compile a pipeline from a repo from the server
+	pipeline, resp, err = c.Pipeline.Validate("github", "octocat", "48afb5bdc41ad69bf22588491333f7cf71135163", opts)
+	if err != nil {
+		fmt.Println(err)
+	}
+
+	fmt.Printf("Received response code %d, for pipeline %+v", resp.StatusCode, pipeline)
 }