Class: Fastlane::Actions::GetConfluencePageAction

Inherits:
Action
  • Object
show all
Defined in:
lib/fastlane/plugin/apadmi_grout/actions/get_confluence_page_action.rb

Overview

Retrieve a Confluence page by title

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



22
23
24
 
# File 'lib/fastlane/plugin/apadmi_grout/actions/get_confluence_page_action.rb', line 22

def self.authors
  ["samdc@apadmi.com"]
end

.available_options ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/fastlane/plugin/apadmi_grout/actions/get_confluence_page_action.rb', line 26

def self.available_options
  Apadmi::Grout::CommonOptions.confluence_options + [
    FastlaneCore::ConfigItem.new(key: :page_title,
                                 description: "Title of the page to retrieve",
                                 type: String,
                                 optional: false),
    FastlaneCore::ConfigItem.new(key: :parent_page_id,
                                 description: "The ID of page's direct parent",
                                 type: String,
                                 optional: false)
  ]
end

.description ⇒ Object 



18
19
20
 
# File 'lib/fastlane/plugin/apadmi_grout/actions/get_confluence_page_action.rb', line 18

def self.description
  "Retrieve a Confluence page by title"
end

.is_supported?(_platform) ⇒ Boolean

Returns:

  • (Boolean) 


43
44
45
 
# File 'lib/fastlane/plugin/apadmi_grout/actions/get_confluence_page_action.rb', line 43

def self.is_supported?(_platform)
  true
end

.return_value ⇒ Object 



39
40
41
 
# File 'lib/fastlane/plugin/apadmi_grout/actions/get_confluence_page_action.rb', line 39

def self.return_value
  "The ConfluencePage if found, nil otherwise"
end

.run(params) ⇒ Object 



11
12
13
14
15
16
 
# File 'lib/fastlane/plugin/apadmi_grout/actions/get_confluence_page_action.rb', line 11

def self.run(params)
  FastLane::FastlaneLogger.new

  confluence_service = Apadmi::Grout::DIWrapper.confluence_service(params)
  Apadmi::Grout::GetConfluencePageAction.new(confluence_service).run(params[:page_title], params[:parent_page_id])
end