class CommandDeployment

Overview

This deployment type runs a command on the local machine (where runway is running) or a remote server (via SSH) The actualy DeploymentConfig setup for the related project determines the command to run

Defined in:

runway/deployments/command.cr

Constructors

Instance Method Summary

Instance methods inherited from class BaseDeployment

deploy(payload : Payload) : Payload deploy

Constructor methods inherited from class BaseDeployment

new(log : Log, deployment_config : DeploymentConfig) new

Constructor Detail

def self.new(log : Log, deployment_config : DeploymentConfig) #

[View source]

Instance Method Detail

def deploy(payload : Payload) : Payload #
Description copied from class BaseDeployment

Executes the deployment. Subclasses must implement this method. In general, this is the actual method that deploys the configured project. Example: A GitHub deployment was triggered, and the check_for_event method detected it... ... since the check_for_event method returns a payload, the deploy method is called with the payload to complete the deployment... ... depending on the event type, there may even be a post_deploy hook that is called after the deployment is complete. @param payload [Payload] The payload containing deployment information (it could be an empty Payload object) but it is required. You might not need it but in case you do, it is there. Certain event types will set rich data on this object and others will not. Check out the deployment_payload.cr file to see what attributes might be available on the Payload object.


[View source]