class Fastlane::Actions::IosReadmeGenerateAction
Public Class Methods
available_options()
click to toggle source
# File lib/fastlane/plugin/ios_readme_generate/actions/ios_readme_generate_action.rb, line 51 def self.available_options [ FastlaneCore::ConfigItem.new(key: :app_name, env_name: "IOS_README_APP_NAME", description: "Add the name of the app", optional: true, type: String), FastlaneCore::ConfigItem.new(key: :app_id, env_name: "IOS_README_APP_ID", description: "Add the ID of the app", optional: true, type: String), FastlaneCore::ConfigItem.new(key: :app_version, env_name: "IOS_README_APP_VERSION", description: "Add the App Version of the app", optional: true, type: String), FastlaneCore::ConfigItem.new(key: :build, env_name: "IOS_README_BUILD", description: "Add the build of the app", optional: true, type: String), FastlaneCore::ConfigItem.new(key: :language, env_name: "IOS_README_LANGUAGE", description: "Add the language with development the app", optional: true, type: String), FastlaneCore::ConfigItem.new(key: :deployment_target, env_name: "IOS_README_DEPLOYMENT_TARGET", description: "Add the deployment of the app", optional: true, type: String), FastlaneCore::ConfigItem.new(key: :file_destination, env_name: "IOS_README_file_destination", description: "Add the destination of the README", optional: true, type: String) ] end
description()
click to toggle source
# File lib/fastlane/plugin/ios_readme_generate/actions/ios_readme_generate_action.rb, line 34 def self.description "Create readme for ios projects :D" end
details()
click to toggle source
# File lib/fastlane/plugin/ios_readme_generate/actions/ios_readme_generate_action.rb, line 46 def self.details # Optional: "Create readme for ios projects" end
is_supported?(platform)
click to toggle source
# File lib/fastlane/plugin/ios_readme_generate/actions/ios_readme_generate_action.rb, line 91 def self.is_supported?(platform) # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example) # See: https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Platforms.md # # [:ios, :mac, :android].include?(platform) true end
return_value()
click to toggle source
# File lib/fastlane/plugin/ios_readme_generate/actions/ios_readme_generate_action.rb, line 42 def self.return_value # If your method provides a return value, you can describe here what it does end
run(params)
click to toggle source
# File lib/fastlane/plugin/ios_readme_generate/actions/ios_readme_generate_action.rb, line 4 def self.run(params) ios_readme = Helper::IosReadmeGenerateHelper.new app_name = ios_readme.addValue("app_name",params[:app_name]) app_id = ios_readme.addValue("app_id",params[:app_id]) app_version = ios_readme.addValue("app_version",params[:app_version]) build = ios_readme.addValue("build",params[:build]) language = ios_readme.addValue("language",params[:language]) deployment_target = ios_readme.addValue("deployment_target",params[:deployment_target]) file_destination = ios_readme.addValue("file_destination",params[:file_destination]) begin command = ["ios-readme-generator", app_name, app_id, app_version, build, language, deployment_target, file_destination].compact.join(" ") Action.sh(command, print_command: true, print_command_output: true) rescue Exception => e UI.error("ios-readme-generator not installed, please install with npm or yarn in global mode.") end end