Class: Fastlane::Actions::JazzyAction

Inherits:
Fastlane::Action show all
Defined in:
fastlane/lib/fastlane/actions/jazzy.rb

Constant Summary

Constants inherited from Fastlane::Action

Fastlane::Action::AVAILABLE_CATEGORIES, Fastlane::Action::RETURN_TYPES

Documentation collapse

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, author, deprecated_notes, details, lane_context, method_missing, other_action, return_type, sample_return_value, shell_out_should_use_bundle_exec?, step_text

Class Method Details

.authors ⇒ Object 



39
40
41
 
# File 'fastlane/lib/fastlane/actions/jazzy.rb', line 39

def self.authors
  ["KrauseFx"]
end

.available_options ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'fastlane/lib/fastlane/actions/jazzy.rb', line 20

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :config,
                                 env_name: 'FL_JAZZY_CONFIG',
                                 description: 'Path to jazzy config file',
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :module_version,
                                 env_name: 'FL_JAZZY_MODULE_VERSION',
                                 description: 'Version string to use as part of the default docs title and inside the docset',
                                 optional: true)
  ]
end

.category ⇒ Object 



54
55
56
 
# File 'fastlane/lib/fastlane/actions/jazzy.rb', line 54

def self.category
  :documentation
end

.description ⇒ Object 



16
17
18
 
# File 'fastlane/lib/fastlane/actions/jazzy.rb', line 16

def self.description
  "Generate docs using Jazzy"
end

.example_code ⇒ Object 



47
48
49
50
51
52
 
# File 'fastlane/lib/fastlane/actions/jazzy.rb', line 47

def self.example_code
  [
    'jazzy',
    'jazzy(config: ".jazzy.yaml", module_version: "2.1.37")'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:



43
44
45
 
# File 'fastlane/lib/fastlane/actions/jazzy.rb', line 43

def self.is_supported?(platform)
  [:ios, :mac].include?(platform)
end

.output ⇒ Object 



33
34
 
# File 'fastlane/lib/fastlane/actions/jazzy.rb', line 33

def self.output
end

.return_value ⇒ Object 



36
37
 
# File 'fastlane/lib/fastlane/actions/jazzy.rb', line 36

def self.return_value
end

.run(params) ⇒ Object 



4
5
6
7
8
9
10
 
# File 'fastlane/lib/fastlane/actions/jazzy.rb', line 4

def self.run(params)
  Actions.verify_gem!('jazzy')
  command = "jazzy"
  command << " --config #{params[:config]}" if params[:config]
  command << " --module-version #{params[:module_version]}" if params[:module_version]
  Actions.sh(command)
end