Class: PlatformAPI::Release

Inherits:
Object
  • Object
show all
Defined in:
lib/platform-api/client.rb

Overview

A release represents a combination of code, config vars and add-ons for an app on Heroku.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Release

Returns a new instance of Release.



2083
2084
2085
 
# File 'lib/platform-api/client.rb', line 2083

def initialize(client)
  @client = client
end

Instance Method Details

#create(app_id_or_app_name, body = {}) ⇒ Object

Create new release.

Parameters:

  • app_id_or_app_name: —

    unique identifier of app or unique name of app

  • body: —

    the object to pass as the request payload



2106
2107
2108
 
# File 'lib/platform-api/client.rb', line 2106

def create(app_id_or_app_name, body = {})
  @client.release.create(app_id_or_app_name, body)
end

#info(app_id_or_app_name, release_id_or_release_version) ⇒ Object

Info for existing release.

Parameters:

  • app_id_or_app_name: —

    unique identifier of app or unique name of app

  • release_id_or_release_version: —

    unique identifier of release or unique version assigned to the release



2091
2092
2093
 
# File 'lib/platform-api/client.rb', line 2091

def info(app_id_or_app_name, release_id_or_release_version)
  @client.release.info(app_id_or_app_name, release_id_or_release_version)
end

#list(app_id_or_app_name) ⇒ Object

List existing releases.

Parameters:

  • app_id_or_app_name: —

    unique identifier of app or unique name of app



2098
2099
2100
 
# File 'lib/platform-api/client.rb', line 2098

def list(app_id_or_app_name)
  @client.release.list(app_id_or_app_name)
end

#rollback(app_id_or_app_name, body = {}) ⇒ Object

Rollback to an existing release.

Parameters:

  • app_id_or_app_name: —

    unique identifier of app or unique name of app

  • body: —

    the object to pass as the request payload



2114
2115
2116
 
# File 'lib/platform-api/client.rb', line 2114

def rollback(app_id_or_app_name, body = {})
  @client.release.rollback(app_id_or_app_name, body)
end