fastlane/lib/fastlane/actions/jazzy.rb in fastlane_hotfix-2.165.1 vs fastlane/lib/fastlane/actions/jazzy.rb in fastlane_hotfix-2.187.0
- old
+ new
@@ -3,10 +3,11 @@
class JazzyAction < Action
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
#####################################################
# @!group Documentation
@@ -16,17 +17,18 @@
"Generate docs using Jazzy"
end
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
- )
+ 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 the default docs title and inside the docset',
+ optional: true)
]
end
def self.output
end
@@ -42,10 +44,11 @@
[:ios, :mac].include?(platform)
end
def self.example_code
[
- 'jazzy'
+ 'jazzy',
+ 'jazzy(config: ".jazzy.yaml", module_version: "2.1.37")'
]
end
def self.category
:documentation