feat(cli): adds always event (#94)

Author: jmgilman

cli/pkg/events/always.go

@@ -0,0 +1,13 @@
+package events
+
+import (
+	"cuelang.org/go/cue"
+	"github.com/input-output-hk/catalyst-forge/lib/project/project"
+)
+
+// AlwaysEvent fires always.
+type AlwaysEvent struct{}
+
+func (m *AlwaysEvent) Firing(p *project.Project, config cue.Value) (bool, error) {
+	return true, nil
+}

cli/pkg/events/events.go

@@ -13,8 +13,9 @@ import (
 type EventType string
 
 const (
-	MergeEventName EventType = "merge"
-	TagEventName   EventType = "tag"
+	AlwaysEventName EventType = "always"
+	MergeEventName  EventType = "merge"
+	TagEventName    EventType = "tag"
 )
 
 // Event represents a CI event.
@@ -37,9 +38,9 @@ type DefaultEventHandler struct {
 
 // Fires returns true if any of the given events are firing.
 func (r *DefaultEventHandler) Firing(p *project.Project, events map[string]cue.Value) bool {
-	for event, config := range events {
-		r.logger.Debug("checking event", "event", event)
-		event, ok := r.store[EventType(event)]
+	for eventName, config := range events {
+		r.logger.Debug("checking event", "event", eventName)
+		event, ok := r.store[EventType(eventName)]
 		if !ok {
 			r.logger.Error("unknown event", "event", event)
 			continue
@@ -52,7 +53,7 @@ func (r *DefaultEventHandler) Firing(p *project.Project, events map[string]cue.V
 		}
 
 		if firing {
-			r.logger.Debug("event is firing", "event", event)
+			r.logger.Debug("event is firing", "event", eventName)
 			return true
 		}
 	}
@@ -65,6 +66,7 @@ func NewDefaultEventHandler(logger *slog.Logger) DefaultEventHandler {
 	return DefaultEventHandler{
 		logger: logger,
 		store: map[EventType]Event{
+			AlwaysEventName: &AlwaysEvent{},
 			MergeEventName: &MergeEvent{
 				logger: logger,
 			},

docs/src/reference/releases/index.md

@@ -26,6 +26,11 @@ Doing so helps prevent merging a potentially broken release configuration.
 
 The supported events are documented below.
 
+#### `always` event
+
+The `always` event is the most straight-forward event in that it always triggers, no matter what.
+This is sometimes useful for previewing or debugging a release.
+
 #### `merge` event
 
 | Field    | Description            | Type   | Default                                  |