feat: adds events for deployments (#105)

Author: jmgilman

.github/workflows/ci.yml

@@ -152,7 +152,7 @@ jobs:
   deploy:
     uses: input-output-hk/catalyst-forge/.github/workflows/deploy.yml@master
     needs: [discover, check, build, test, release]
-    if: (fromJson(needs.discover.outputs.deployments)[0] != null) && github.ref == format('refs/heads/{0}', github.event.repository.default_branch) && !failure() && !cancelled()
+    if: (fromJson(needs.discover.outputs.deployments)[0] != null) && !failure() && !cancelled()
     with:
       deployments: ${{ needs.discover.outputs.deployments }}
       forge_version: ${{ inputs.forge_version }}

cli/cmd/cmds/deploy/deploy.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 
 	"github.com/input-output-hk/catalyst-forge/cli/pkg/deployment"
+	"github.com/input-output-hk/catalyst-forge/cli/pkg/events"
 	"github.com/input-output-hk/catalyst-forge/cli/pkg/run"
 )
 
@@ -17,6 +18,12 @@ func (c *PushCmd) Run(ctx run.RunContext) error {
 		return fmt.Errorf("could not load project: %w", err)
 	}
 
+	eh := events.NewDefaultEventHandler(ctx.Logger)
+	if !eh.Firing(&project, project.GetDeploymentEvents()) {
+		ctx.Logger.Info("No deployment event is firing, skipping deployment")
+		return nil
+	}
+
 	deployer := deployment.NewGitopsDeployer(&project, &ctx.SecretStore, ctx.Logger)
 	if err := deployer.Load(); err != nil {
 		return fmt.Errorf("could not load deployer: %w", err)

foundry/api/blueprint.cue

@@ -14,14 +14,18 @@ project: {
 		}
 	}
 	deployment: {
+		on: {
+			merge: {}
+			tag: {}
+		}
 		environment: "dev"
 		modules: main: {
 			container: "foundry-api-deployment"
 			version:   "0.1.1"
 			values: {
 				environment: name: "dev"
 				server: image: {
-					tag: _ @forge(name="GIT_COMMIT_HASH")
+					tag: _ @forge(name="GIT_HASH_OR_TAG")
 				}
 			}
 		}

lib/project/project/project.go

@@ -81,6 +81,17 @@ func (p *Project) GetRelativePath() (string, error) {
 	return relPath, nil
 }
 
+// GetDeploymentEvents returns the deployment events for a project.
+func (p *Project) GetDeploymentEvents() map[string]cue.Value {
+	events := make(map[string]cue.Value)
+	for event := range p.Blueprint.Project.Deployment.On {
+		config := p.RawBlueprint.Get(fmt.Sprintf("project.deployment.on.%s", event))
+		events[event] = config
+	}
+
+	return events
+}
+
 // GetReleaseEvents returns the release events for a release.
 func (p *Project) GetReleaseEvents(releaseName string) map[string]cue.Value {
 	release, ok := p.Blueprint.Project.Release[releaseName]

lib/project/schema/_embed/schema.cue

@@ -193,6 +193,11 @@ package schema
 		string
 	} @go(Environment)
 
+	// On contains the events that trigger the deployment.
+	on: {
+		...
+	} @go(On,map[string]any)
+
 	// Modules contains the configuration for the deployment modules for the project.
 	// +optional
 	modules?: null | #DeploymentModules @go(Modules,*DeploymentModules)

lib/project/schema/deployment.go

@@ -5,6 +5,9 @@ type Deployment struct {
 	// Environment contains the environment to deploy the module to.
 	Environment string `json:"environment"`
 
+	// On contains the events that trigger the deployment.
+	On map[string]any `json:"on"`
+
 	// Modules contains the configuration for the deployment modules for the project.
 	// +optional
 	Modules *DeploymentModules `json:"modules"`

lib/project/schema/deployment_go_gen.cue

@@ -9,6 +9,9 @@ package schema
 	// Environment contains the environment to deploy the module to.
 	environment: string @go(Environment)
 
+	// On contains the events that trigger the deployment.
+	on: {...} @go(On,map[string]any)
+
 	// Modules contains the configuration for the deployment modules for the project.
 	// +optional
 	modules?: null | #DeploymentModules @go(Modules,*DeploymentModules)