Class: Fastlane::Actions::SkipDocsAction

Inherits:
Fastlane::Action show all
Defined in:
fastlane/lib/fastlane/actions/skip_docs.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, lane_context, method_missing, other_action, return_type, sample_return_value, shell_out_should_use_bundle_exec?

Class Method Details

.authorsObject


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

def self.authors
  ["KrauseFx"]
end

.available_optionsObject


20
21
# File 'fastlane/lib/fastlane/actions/skip_docs.rb', line 20

def self.available_options
end

.categoryObject


47
48
49
# File 'fastlane/lib/fastlane/actions/skip_docs.rb', line 47

def self.category
  :misc
end

.descriptionObject


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

def self.description
  "Skip the creation of the fastlane/README.md file when running fastlane"
end

.detailsObject


29
30
31
# File 'fastlane/lib/fastlane/actions/skip_docs.rb', line 29

def self.details
  "Tell _fastlane_ to not automatically create a `fastlane/README.md` when running _fastlane_. You can always trigger the creation of this file manually by running `fastlane docs`."
end

.example_codeObject


41
42
43
44
45
# File 'fastlane/lib/fastlane/actions/skip_docs.rb', line 41

def self.example_code
  [
    'skip_docs'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:


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

def self.is_supported?(platform)
  true
end

.outputObject


23
24
# File 'fastlane/lib/fastlane/actions/skip_docs.rb', line 23

def self.output
end

.return_valueObject


26
27
# File 'fastlane/lib/fastlane/actions/skip_docs.rb', line 26

def self.return_value
end

.run(params) ⇒ Object


4
5
6
# File 'fastlane/lib/fastlane/actions/skip_docs.rb', line 4

def self.run(params)
  ENV["FASTLANE_SKIP_DOCS"] = "1"
end

.step_textObject


8
9
10
# File 'fastlane/lib/fastlane/actions/skip_docs.rb', line 8

def self.step_text
  nil
end