Add RunningDeploymentSource and TargetDeploymentSource to ExecuteStag…

…eRequest (#5606) * Add RunningDeploymentSource and TargetDeploymentSource to ExecuteStageRequest Signed-off-by: Shinnosuke Sawada-Dazai <[email protected]> * Add RunningDeploymentSource and TargetDeploymentSource to ExecuteStageRequest Signed-off-by: Shinnosuke Sawada-Dazai <[email protected]> --------- Signed-off-by: Shinnosuke Sawada-Dazai <[email protected]>
pipe-cd · Feb 26, 2025 · c2aca82 · c2aca82
1 parent 855aa0a
commit c2aca82
Showing 1 changed file with 34 additions and 2 deletions.
diff --git a/pkg/plugin/sdk/deployment.go b/pkg/plugin/sdk/deployment.go
@@ -27,6 +27,7 @@ import (
 
 	config "github.com/pipe-cd/pipecd/pkg/configv1"
 	"github.com/pipe-cd/pipecd/pkg/model"
+	"github.com/pipe-cd/pipecd/pkg/plugin/api/v1alpha1/common"
 	"github.com/pipe-cd/pipecd/pkg/plugin/api/v1alpha1/deployment"
 	"github.com/pipe-cd/pipecd/pkg/plugin/logpersister"
 	"github.com/pipe-cd/pipecd/pkg/plugin/pipedapi"
@@ -309,8 +310,10 @@ func executeStage[Config, DeployTargetConfig any](
 ) (*deployment.ExecuteStageResponse, error) {
 	in := &ExecuteStageInput{
 		Request: ExecuteStageRequest{
-			StageName:   request.GetInput().GetStage().GetName(),
-			StageConfig: request.GetInput().GetStageConfig(),
+			StageName:               request.GetInput().GetStage().GetName(),
+			StageConfig:             request.GetInput().GetStageConfig(),
+			RunningDeploymentSource: newDeploymentSource(request.GetInput().GetRunningDeploymentSource()),
+			TargetDeploymentSource:  newDeploymentSource(request.GetInput().GetTargetDeploymentSource()),
 		},
 		Client: client,
 		Logger: logger,
@@ -551,6 +554,35 @@ type ExecuteStageRequest struct {
 	StageName string
 	// Json encoded configuration of the stage.
 	StageConfig []byte
+
+	// RunningDeploymentSource is the source of the running deployment.
+	RunningDeploymentSource DeploymentSource
+
+	// TargetDeploymentSource is the source of the target deployment.
+	TargetDeploymentSource DeploymentSource
+}
+
+// DeploymentSource represents the source of the deployment.
+type DeploymentSource struct {
+	// ApplicationDirectory is the directory where the source code is located.
+	ApplicationDirectory string
+	// CommitHash is the git commit hash of the source code.
+	CommitHash string
+	// ApplicationConfig is the configuration of the application.
+	ApplicationConfig []byte
+	// ApplicationConfigFilename is the name of the file that contains the application configuration.
+	// The plugins can use this to avoid mistakenly reading this file as a manifest to deploy.
+	ApplicationConfigFilename string
+}
+
+// newDeploymentSource converts the common.DeploymentSource to the internal representation.
+func newDeploymentSource(source *common.DeploymentSource) DeploymentSource {
+	return DeploymentSource{
+		ApplicationDirectory:      source.GetApplicationDirectory(),
+		CommitHash:                source.GetCommitHash(),
+		ApplicationConfig:         source.GetApplicationConfig(),
+		ApplicationConfigFilename: source.GetApplicationConfigFilename(),
+	}
 }
 
 // ExecuteStageResponse is the response of the request to execute a stage.