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

.authorsObject


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

def self.authors
  ["KrauseFx"]
end

.available_optionsObject


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

def self.available_options
  [
    FastlaneCore::ConfigItem.new(
      key: :config,
      env_name: 'FL_JAZZY_CONFIG',
      description: 'Path to jazzy config file',
      is_string: true,
      optional: true
    )
  ]
end

.categoryObject


51
52
53
# File 'fastlane/lib/fastlane/actions/jazzy.rb', line 51

def self.category
  :documentation
end

.descriptionObject


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

def self.description
  "Generate docs using Jazzy"
end

.example_codeObject


45
46
47
48
49
# File 'fastlane/lib/fastlane/actions/jazzy.rb', line 45

def self.example_code
  [
    'jazzy'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:


41
42
43
# File 'fastlane/lib/fastlane/actions/jazzy.rb', line 41

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

.outputObject


31
32
# File 'fastlane/lib/fastlane/actions/jazzy.rb', line 31

def self.output
end

.return_valueObject


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

def self.return_value
end

.run(params) ⇒ Object


4
5
6
7
8
9
# 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]
  Actions.sh(command)
end