fastlane-plugin-docc 0.1.0 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +7 -5
- data/lib/fastlane/plugin/docc/actions/docc_action.rb +19 -3
- data/lib/fastlane/plugin/docc/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 665c5b52febcf2630f831bccd427429cd8afeb9245efbd4715a7d1d7da4ed8df
|
|
4
|
+
data.tar.gz: 33a65b1bca7d6ef4963954b27da8bd24ff8d1f9fc6f51c46bd5b2f1447a07881
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 06113fb1c462a44feff93f9d590637d13429ff189d2a3ff7bafe452a07c912276c40b9cca8aa625516b451f7d9f73c9c03fd0624a1857bd21e5aed0e84cf6b5b
|
|
7
|
+
data.tar.gz: 3d85c93685bedde70eb0fcfb0868ba8ee1a0f49b54ff51c036f0dd886c7bfd3bc4f3e7b63111cc3a572657e87cba048b5c65adc398265efd1d8fc067e23f7592
|
data/README.md
CHANGED
|
@@ -22,17 +22,19 @@ Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plu
|
|
|
22
22
|
|
|
23
23
|
```ruby
|
|
24
24
|
docc(
|
|
25
|
-
scheme: "<
|
|
25
|
+
scheme: "<The name of your package/library scheme>",
|
|
26
26
|
derived_data_path: "<The path to write the DocC to>"
|
|
27
27
|
)
|
|
28
28
|
```
|
|
29
29
|
|
|
30
30
|
## List of all Parameters
|
|
31
31
|
|
|
32
|
-
| Key | Description
|
|
33
|
-
| ----------------- |
|
|
34
|
-
| scheme | The
|
|
35
|
-
| derived_data_path | The path to write the DocC to.
|
|
32
|
+
| Key | Description | default value |
|
|
33
|
+
| ----------------- | ------------------------------------------------------------- | ------------- |
|
|
34
|
+
| scheme | The scheme you want generate DocC for. | |
|
|
35
|
+
| derived_data_path | The path to write the DocC to. | |
|
|
36
|
+
| destination | The destination of the project (required for swift packages). | |
|
|
37
|
+
| configuration | The configuration for building the project (e.g. 'Debug'). | |
|
|
36
38
|
|
|
37
39
|
## Run tests for this plugin
|
|
38
40
|
|
|
@@ -9,11 +9,17 @@ module Fastlane
|
|
|
9
9
|
command << "xcodebuild docbuild"
|
|
10
10
|
command << "-scheme #{params[:scheme]}"
|
|
11
11
|
command << "-derivedDataPath #{params[:derived_data_path]}" unless params[:derived_data_path].nil?
|
|
12
|
+
command << "-destination #{params[:destination]}" unless params[:destination].nil?
|
|
13
|
+
command << "-configuration #{params[:configuration]}" unless params[:configuration].nil?
|
|
12
14
|
|
|
13
15
|
shell_command = command.join(' ')
|
|
14
16
|
UI.message(shell_command.to_s)
|
|
17
|
+
selected_version = sh("xcodebuild -version").match(/^Xcode (.*)$/)
|
|
18
|
+
pure_version = selected_version.to_s.sub('Xcode ', '')
|
|
15
19
|
|
|
16
|
-
|
|
20
|
+
unless selected_version.nil? == true
|
|
21
|
+
UI.user_error!("Make sure Xcode 13 is installed and select it for Command Line Tool - your version: #{selected_version}") unless pure_version.to_i >= 13.0
|
|
22
|
+
end
|
|
17
23
|
|
|
18
24
|
sh(shell_command.to_s)
|
|
19
25
|
end
|
|
@@ -39,13 +45,23 @@ module Fastlane
|
|
|
39
45
|
[
|
|
40
46
|
FastlaneCore::ConfigItem.new(key: :scheme,
|
|
41
47
|
env_name: "DOCC_SCHEME",
|
|
42
|
-
description: "
|
|
48
|
+
description: "The scheme to use when calling docc",
|
|
43
49
|
optional: false,
|
|
44
50
|
type: String),
|
|
45
51
|
|
|
46
52
|
FastlaneCore::ConfigItem.new(key: :derived_data_path,
|
|
47
53
|
env_name: "DOCC_DERIVED_DATA_PATH",
|
|
48
|
-
description: "
|
|
54
|
+
description: "The path where the documentation will be created",
|
|
55
|
+
optional: true,
|
|
56
|
+
type: String),
|
|
57
|
+
FastlaneCore::ConfigItem.new(key: :destination,
|
|
58
|
+
env_name: "DESTINATION",
|
|
59
|
+
description: "The destination of the project (required for swift packages)",
|
|
60
|
+
optional: true,
|
|
61
|
+
type: String),
|
|
62
|
+
FastlaneCore::ConfigItem.new(key: :configuration,
|
|
63
|
+
env_name: "CONFIGURATION",
|
|
64
|
+
description: "The configuration for building the project (e.g. 'Debug')",
|
|
49
65
|
optional: true,
|
|
50
66
|
type: String)
|
|
51
67
|
]
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: fastlane-plugin-docc
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version:
|
|
4
|
+
version: 1.1.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Kukurijek
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2022-03-11 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: pry
|