From c3964dc7c47c5cf68d7eaf000831396d790ec54a Mon Sep 17 00:00:00 2001 From: Ozan Tepe Date: Fri, 22 Nov 2024 11:44:15 +0100 Subject: [PATCH] update readme (#55) --- README.md | 6 +++--- lib/fastlane/plugin/dynatrace/actions/dynatrace_action.rb | 6 +++--- spec/dynatrace_action_spec.rb | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 8d8a93c..143f005 100644 --- a/README.md +++ b/README.md @@ -52,9 +52,9 @@ Now, when you run fastlane, the Dynatrace plugin will manage the symbol files of | server | The API endpoint for the Dynatrace environment (e.g. `https://environmentID.live.dynatrace.com` or `https://dynatrace-managed.com/e/environmentID`). | | | cleanBuildArtifacts | Clean build artifacts after processing. | `false` | | tempdir | (OPTIONAL) Custom temporary directory for the DTXDssClient. **The plugin does not take care of cleaning this directory.** | | -| debugMode | Enable debug logging. | `false` | -| customLLDBFrameworkPath | (OPTIONAL) Custom path to the LLDB framework used as runtime dependency by DTXDssClient (e.g. `/Users/test/Documents/LLDB.framework`). | | -| autoSymlinkLLDB | (OPTIONAL) Automatically find and create a symlink to the LLDB framework into the DTXDssClient's temporary folder. | `true` | +| debugMode | (OPTIONAL) Enable debug logging. | `false` | +| customLLDBFrameworkPath | *(iOS/tvOS only)* (OPTIONAL) Custom path to the LLDB framework used as runtime dependency by DTXDssClient (e.g. `/Users/test/Documents/LLDB.framework`). | | +| autoSymlinkLLDB | *(iOS/tvOS only)* (OPTIONAL) Automatically find and create a symlink to the LLDB framework into the DTXDssClient's temporary folder. | `true` | ## Example Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`. diff --git a/lib/fastlane/plugin/dynatrace/actions/dynatrace_action.rb b/lib/fastlane/plugin/dynatrace/actions/dynatrace_action.rb index b82fce0..368c756 100644 --- a/lib/fastlane/plugin/dynatrace/actions/dynatrace_action.rb +++ b/lib/fastlane/plugin/dynatrace/actions/dynatrace_action.rb @@ -223,19 +223,19 @@ def self.available_options FastlaneCore::ConfigItem.new(key: :debugMode, env_name: "FL_UPLOAD_TO_DYNATRACE_DEBUG_MODE", - description: "Enable debug logging", + description: "(OPTIONAL) Enable debug logging", default_value: false, is_string: false, optional: true), FastlaneCore::ConfigItem.new(key: :customLLDBFrameworkPath, env_name: "FL_UPLOAD_TO_DYNATRACE_LLDB_PATH", - description: "Custom path to the LLDB framework used as runtime dependency by DTXDssClient", + description: "(iOS/tvOS only) (OPTIONAL) Custom path to the LLDB framework used as runtime dependency by DTXDssClient", optional: true), FastlaneCore::ConfigItem.new(key: :autoSymlinkLLDB, env_name: "FL_UPLOAD_TO_DYNATRACE_AUTO_LINK_LLDB", - description: "Automatically find and create a symlink to the LLDB framework into the DTXDssClient's temporary folder", + description: "(iOS/tvOS only) (OPTIONAL) Automatically find and create a symlink to the LLDB framework into the DTXDssClient's temporary folder", type: Boolean, default_value: true, optional: true) diff --git a/spec/dynatrace_action_spec.rb b/spec/dynatrace_action_spec.rb index 3a683f4..80d3aab 100644 --- a/spec/dynatrace_action_spec.rb +++ b/spec/dynatrace_action_spec.rb @@ -15,7 +15,7 @@ def mock_config FastlaneCore::ConfigItem.new(key: :dtxDssClientPath, type: String, optional: false), FastlaneCore::ConfigItem.new(key: :appId, type: String, optional: false), FastlaneCore::ConfigItem.new(key: :cleanBuildArtifacts, type: Object, optional: true), - FastlaneCore::ConfigItem.new(key: :tempdir, type: String, optional: false), + FastlaneCore::ConfigItem.new(key: :tempdir, type: String, optional: true), FastlaneCore::ConfigItem.new(key: :debugMode, type: Object, optional: true), FastlaneCore::ConfigItem.new(key: :symbolsfileAutoZip, type: Object, optional: false), FastlaneCore::ConfigItem.new(key: :customLLDBFrameworkPath, type: String, optional: true),