class Event

Overview

The Event class represents an event that triggers a deployment for a project. It includes properties for the event's type, repository, environment, and schedule.

Included Modules

Defined in:

runway/models/config.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(ctx : YAML::ParseContext, node : YAML::Nodes::Node) #

[View source]

Instance Method Detail

def cleanup : Bool | Nil #

@return [Bool, nil] A flag to enable property cleanup, or nil if not specified. Used by a few event types.


[View source]
def cleanup=(cleanup : Bool | Nil) #

@return [Bool, nil] A flag to enable property cleanup, or nil if not specified. Used by a few event types.


[View source]
def deployment_filter : Int32 | Nil #

@return [Int32, nil] The deployment filter for the event, or nil if not specified. Deployment filters are used to filter out deployments to X number of most recent deployments This helps save on API requests and prevent unnecessary deployments This property is specific to the github_deployment event type


[View source]
def deployment_filter=(deployment_filter : Int32 | Nil) #

@return [Int32, nil] The deployment filter for the event, or nil if not specified. Deployment filters are used to filter out deployments to X number of most recent deployments This helps save on API requests and prevent unnecessary deployments This property is specific to the github_deployment event type


[View source]
def environment : String | Nil #

@return [String, nil] The environment for the event, or nil if not specified.


[View source]
def environment=(environment : String | Nil) #

@return [String, nil] The environment for the event, or nil if not specified.


[View source]
def path : String | Nil #

@return [String, nil] A path for a file, or nil if not specified. Used by a few event types.


[View source]
def path=(path : String | Nil) #

@return [String, nil] A path for a file, or nil if not specified. Used by a few event types.


[View source]
def repo : String | Nil #

@return [String, nil] The repository for the event, or nil if not specified.


[View source]
def repo=(repo : String | Nil) #

@return [String, nil] The repository for the event, or nil if not specified.


[View source]
def schedule : Schedule #

@return [Schedule] The schedule for the event.


[View source]
def schedule=(schedule : Schedule) #

@return [Schedule] The schedule for the event.


[View source]
def type : String #

@return [String] The type of the event.


[View source]
def type=(type : String) #

@return [String] The type of the event.


[View source]
def uuid : String | Nil #

@return [String, nil] The UUID for the event, or nil if not specified. The application will generate a UUID for the event if one is not provided.


[View source]
def uuid=(uuid : String | Nil) #

@return [String, nil] The UUID for the event, or nil if not specified. The application will generate a UUID for the event if one is not provided.


[View source]