class GitHubDeployment

Defined in:

runway/events/github_deployment.cr

Constructors

Instance Method Summary

Instance methods inherited from class BaseEvent

check_for_event : Payload check_for_event, post_deploy(payload : Payload) : Payload post_deploy

Constructor methods inherited from class BaseEvent

new(log : Log, event : Event) new

Constructor Detail

def self.new(log : Log, event : Event) #

[View source]

Instance Method Detail

def check_for_event : Payload #

Check for a GitHub deployment event in the specified environment This method uses post_deploy hooks to create a deployment status for the deployment after a deployment completes/fails


[View source]
def extra_post_branch_deploy_steps(payload : Payload) #

This method gets called from the post_deploy() method if the branch_deploy_enabled attribute is true It will perform extra steps that are specific to github/branch-deploy workflows. For example, it will remove the initial reaction from the branch-deploy trigger comment if we are configured to do so... ... and it will also add a reaction to the branch-deploy trigger comment based on the payload's success attribute


[View source]
def post_deploy(payload : Payload) : Payload #

This method is called after the project's deployment has completed It will create a GitHub deployment status that reflects the deployment's success or failure The deployment status to use comes from the Payload.status attribute (success or failure) @param payload [Payload] the payload object that contains the deployment status and other information @return [Payload] the payload object that was passed in with possibly updated information/attributes


[View source]