Module: HybridPlatformsConductor::CommonConfigDsl::Confluence

Defined in:
lib/hybrid_platforms_conductor/common_config_dsl/confluence.rb

Instance Method Summary collapse

Instance Method Details

#confluence(url:, inventory_report_page_id: nil, tests_report_page_id: nil) ⇒ Object

Register a Confluence server

Parameters

  • url (String): URL to the Confluence server

  • inventory_report_page_id (String or nil): Confluence page id used for inventory reports, or nil if none [default: nil]

  • tests_report_page_id (String or nil): Confluence page id used for test reports, or nil if none [default: nil]



20
21
22
23
24
25
26
 
# File 'lib/hybrid_platforms_conductor/common_config_dsl/confluence.rb', line 20

def confluence(url:, inventory_report_page_id: nil, tests_report_page_id: nil)
  @confluence = {
    url: url,
    inventory_report_page_id: inventory_report_page_id,
    tests_report_page_id: tests_report_page_id
  }
end

#confluence_info ⇒ Object

Return the Confluence information

Result

  • Hash<Symbol, Object> or nil: The Confluence information, or nil if none

    • url (String): The Confluence URL.

    • inventory_report_page_id (String or nil): Confluence page id used for inventory reports, or nil if none.

    • tests_report_page_id (String or nil): Confluence page id used for test reports, or nil if none.



35
36
37
 
# File 'lib/hybrid_platforms_conductor/common_config_dsl/confluence.rb', line 35

def confluence_info
  @confluence
end

#init_confluence ⇒ Object

Initialize the DSL



8
9
10
11
12
 
# File 'lib/hybrid_platforms_conductor/common_config_dsl/confluence.rb', line 8

def init_confluence
  # Confluence configuration (can be nil if none)
  # Hash<Symbol, Object> or nil. See #confluence_info to know details.
  @confluence = nil
end