Merge pull request #1041 from watson-developer-cloud/finalize-major-r…

…elease chore(readme): add known issue about XCode 12
watson-developer-cloud · Dec 21, 2020 · f58b90e · f58b90e
2 parents 396ebfc + df70c70
commit f58b90e
Show file tree

Hide file tree

Showing 31 changed files with 47 additions and 46 deletions.
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 3.6.0
+current_version = 4.0.0
 commit = True
 message = Release version {new_version} [skip ci]
 
@@ -62,4 +62,3 @@ message = Release version {new_version} [skip ci]
 [bumpversion:file:Scripts/jazzy-config/VisualRecognitionV3.jazzy.yaml]
 
 [bumpversion:file:Scripts/jazzy-config/VisualRecognitionV4.jazzy.yaml]
-
diff --git a/IBMWatsonAssistantV1.podspec b/IBMWatsonAssistantV1.podspec
@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name                  = 'IBMWatsonAssistantV1'
-  s.version               = '3.6.0'
+  s.version               = '4.0.0'
   s.summary               = 'Client framework for the IBM Watson Assistant service'
   s.description           = <<-DESC
 With the IBM Watson™ Assistant service, you can build a solution that understands

diff --git a/IBMWatsonAssistantV2.podspec b/IBMWatsonAssistantV2.podspec
@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name                  = 'IBMWatsonAssistantV2'
-  s.version               = '3.6.0'
+  s.version               = '4.0.0'
   s.summary               = 'Client framework for the IBM Watson Assistant service'
   s.description           = <<-DESC
 With the IBM Watson™ Assistant service, you can build a solution that understands

diff --git a/IBMWatsonCompareComplyV1.podspec b/IBMWatsonCompareComplyV1.podspec
@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name                  = 'IBMWatsonCompareComplyV1'
-  s.version               = '3.6.0'
+  s.version               = '4.0.0'
   s.summary               = 'Client framework for the IBM Watson Compare & Comply service'
   s.description           = <<-DESC
 IBM Watson™ Compare and Comply analyzes governing documents to provide details about critical aspects of the documents.

diff --git a/IBMWatsonDiscoveryV1.podspec b/IBMWatsonDiscoveryV1.podspec
@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name                  = 'IBMWatsonDiscoveryV1'
-  s.version               = '3.6.0'
+  s.version               = '4.0.0'
   s.summary               = 'Client framework for the IBM Watson Discovery service'
   s.description           = <<-DESC
 IBM Watson™ Discovery makes it possible to rapidly build cognitive, cloud-based exploration applications

diff --git a/IBMWatsonDiscoveryV2.podspec b/IBMWatsonDiscoveryV2.podspec
@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name                  = 'IBMWatsonDiscoveryV2'
-  s.version               = '3.6.0'
+  s.version               = '4.0.0'
   s.summary               = 'Client framework for the IBM Watson Discovery V2 service'
   s.description           = <<-DESC
 IBM Watson™ Discovery makes it possible to rapidly build cognitive, cloud-based exploration applications

diff --git a/IBMWatsonLanguageTranslatorV3.podspec b/IBMWatsonLanguageTranslatorV3.podspec
@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name                  = 'IBMWatsonLanguageTranslatorV3'
-  s.version               = '3.6.0'
+  s.version               = '4.0.0'
   s.summary               = 'Client framework for the IBM Watson Language Translator service'
   s.description           = <<-DESC
 IBM Watson™ Language Translator can identify the language of text and translate it into different languages programmatically.

diff --git a/IBMWatsonNaturalLanguageClassifierV1.podspec b/IBMWatsonNaturalLanguageClassifierV1.podspec
@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name                  = 'IBMWatsonNaturalLanguageClassifierV1'
-  s.version               = '3.6.0'
+  s.version               = '4.0.0'
   s.summary               = 'Client framework for the IBM Watson Natural Language Classifier service'
   s.description           = <<-DESC
 Natural Language Classifier can help your application understand the language of short texts and

diff --git a/IBMWatsonNaturalLanguageUnderstandingV1.podspec b/IBMWatsonNaturalLanguageUnderstandingV1.podspec
@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name                  = 'IBMWatsonNaturalLanguageUnderstandingV1'
-  s.version               = '3.6.0'
+  s.version               = '4.0.0'
   s.summary               = 'Client framework for the IBM Watson Natural Language Understanding service'
   s.description           = <<-DESC
 IBM Watson™ Natural Language Understanding can analyze semantic features of text input,

diff --git a/IBMWatsonPersonalityInsightsV3.podspec b/IBMWatsonPersonalityInsightsV3.podspec
@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name                  = 'IBMWatsonPersonalityInsightsV3'
-  s.version               = '3.6.0'
+  s.version               = '4.0.0'
   s.summary               = 'Client framework for the IBM Watson Personality Insights service'
   s.description           = <<-DESC
 IBM Watson™ Personality Insights uses linguistic analytics to infer individuals' intrinsic personality characteristics

diff --git a/IBMWatsonSpeechToTextV1.podspec b/IBMWatsonSpeechToTextV1.podspec
@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name                  = 'IBMWatsonSpeechToTextV1'
-  s.version               = '3.6.0'
+  s.version               = '4.0.0'
   s.summary               = 'Client framework for the IBM Watson Speech to Text service'
   s.description           = <<-DESC
 The IBM® Speech to Text leverages machine intelligence to transcribe the human voice accurately.

diff --git a/IBMWatsonTextToSpeechV1.podspec b/IBMWatsonTextToSpeechV1.podspec
@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name                  = 'IBMWatsonTextToSpeechV1'
-  s.version               = '3.6.0'
+  s.version               = '4.0.0'
   s.summary               = 'Client framework for the IBM Watson Text to Speech service'
   s.description           = <<-DESC
 IBM® Text to Speech uses IBM's speech-synthesis capabilities to convert written text to natural-sounding speech.

diff --git a/IBMWatsonToneAnalyzerV3.podspec b/IBMWatsonToneAnalyzerV3.podspec
@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name                  = 'IBMWatsonToneAnalyzerV3'
-  s.version               = '3.6.0'
+  s.version               = '4.0.0'
   s.summary               = 'Client framework for the IBM Watson Tone Analyzer service'
   s.description           = <<-DESC
 IBM Watson™ Tone Analyzer uses linguistic analysis to detect emotional and language tones in written text.

diff --git a/IBMWatsonVisualRecognitionV3.podspec b/IBMWatsonVisualRecognitionV3.podspec
@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name                  = 'IBMWatsonVisualRecognitionV3'
-  s.version               = '3.6.0'
+  s.version               = '4.0.0'
   s.summary               = 'Client framework for the IBM Watson Visual Recognition service'
   s.description           = <<-DESC
 IBM Watson™ Visual Recognition uses deep learning algorithms to analyze images for

diff --git a/IBMWatsonVisualRecognitionV4.podspec b/IBMWatsonVisualRecognitionV4.podspec
@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name                  = 'IBMWatsonVisualRecognitionV4'
-  s.version               = '3.6.0'
+  s.version               = '4.0.0'
   s.summary               = 'Client framework for the IBM Watson Visual Recognition V4 service'
   s.description           = <<-DESC
 IBM Watson™ Visual Recognition uses deep learning algorithms to analyze images for

diff --git a/README.md b/README.md
@@ -89,18 +89,18 @@ If your project does not yet have a Podfile, use the `pod init` command in the r
 use_frameworks!
 
 target 'MyApp' do
-    pod 'IBMWatsonAssistantV1', '~> 3.6.0'
-    pod 'IBMWatsonAssistantV2', '~> 3.6.0'
-    pod 'IBMWatsonCompareComplyV1', '~> 3.6.0'
-    pod 'IBMWatsonDiscoveryV1', '~> 3.6.0'
-    pod 'IBMWatsonLanguageTranslatorV3', '~> 3.6.0'
-    pod 'IBMWatsonNaturalLanguageClassifierV1', '~> 3.6.0'
-    pod 'IBMWatsonNaturalLanguageUnderstandingV1', '~> 3.6.0'
-    pod 'IBMWatsonPersonalityInsightsV3', '~> 3.6.0'
-    pod 'IBMWatsonSpeechToTextV1', '~> 3.6.0'
-    pod 'IBMWatsonTextToSpeechV1', '~> 3.6.0'
-    pod 'IBMWatsonToneAnalyzerV3', '~> 3.6.0'
-    pod 'IBMWatsonVisualRecognitionV3', '~> 3.6.0'
+    pod 'IBMWatsonAssistantV1', '~> 4.0.0'
+    pod 'IBMWatsonAssistantV2', '~> 4.0.0'
+    pod 'IBMWatsonCompareComplyV1', '~> 4.0.0'
+    pod 'IBMWatsonDiscoveryV1', '~> 4.0.0'
+    pod 'IBMWatsonLanguageTranslatorV3', '~> 4.0.0'
+    pod 'IBMWatsonNaturalLanguageClassifierV1', '~> 4.0.0'
+    pod 'IBMWatsonNaturalLanguageUnderstandingV1', '~> 4.0.0'
+    pod 'IBMWatsonPersonalityInsightsV3', '~> 4.0.0'
+    pod 'IBMWatsonSpeechToTextV1', '~> 4.0.0'
+    pod 'IBMWatsonTextToSpeechV1', '~> 4.0.0'
+    pod 'IBMWatsonToneAnalyzerV3', '~> 4.0.0'
+    pod 'IBMWatsonVisualRecognitionV3', '~> 4.0.0'
 end
 ```
 
@@ -125,7 +125,7 @@ $ brew install carthage
 If your project does not have a Cartfile yet, use the `touch Cartfile` command in the root directory of your project. To install the IBM Watson Swift SDK using Carthage, add the following to your Cartfile.
 
 ```
-github "watson-developer-cloud/swift-sdk" ~> 3.6.0
+github "watson-developer-cloud/swift-sdk" ~> 4.0.0
 ```
 
 Then run the following command to build the dependencies and frameworks:
@@ -148,13 +148,15 @@ Add the following to your `Package.swift` file to identify the IBM Watson Swift
 
 ```swift
 dependencies: [
-    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "3.6.0")
+    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "4.0.0")
 ]
 ```
 
 ## Known Issues
 
-There is a known issue with Carthage and XCode 12 that prevents installation of the required dependency Starscream. There is already an [issue thread](https://github.com/Carthage/Carthage/issues/3019) up on the Carthage repository with a [workaround script](https://github.com/getsentry/sentry-cocoa/pull/780) that can be run to address the issue.  Until there is a version released that truly addresses this issue, it is recommended to either use one of the other two package managers or use the workaround script. 
+The release of XCode 12 created issues in both Cocoapods and Carthage preventing the use of these package managers with no current easy fixes. Current use of this sdk will only work with Xcode 11.7 and below. In the future, we will be dropping support for Cocoapods and Carthage in favor of Swift Package Manager
+
+There is a workaround in Carthage to get this sdk to work with XCode 12. An [issue thread](https://github.com/Carthage/Carthage/issues/3019) up on the Carthage repository contains a [workaround script](https://github.com/getsentry/sentry-cocoa/pull/780) that can be run to address the issue.  Until there is a version released that truly addresses this issue, it is recommended to use this sdk with XCode 11.7 or below. 
 
 ## Authentication
 

diff --git a/Scripts/jazzy-config/AssistantV1.jazzy.yaml b/Scripts/jazzy-config/AssistantV1.jazzy.yaml
@@ -4,7 +4,7 @@ github_url: https://github.com/watson-developer-cloud/swift-sdk
 clean: true
 output: ../../gh-pages/services/AssistantV1
 module: AssistantV1
-module_version: "3.6.0"
+module_version: "4.0.0"
 documentation: ../../Sources/AssistantV1/README.md
 readme: ../../Sources/AssistantV1/README.md
 build_tool_arguments:

diff --git a/Scripts/jazzy-config/AssistantV2.jazzy.yaml b/Scripts/jazzy-config/AssistantV2.jazzy.yaml
@@ -4,7 +4,7 @@ github_url: https://github.com/watson-developer-cloud/swift-sdk
 clean: true
 output: ../../gh-pages/services/AssistantV2
 module: AssistantV2
-module_version: "3.6.0"
+module_version: "4.0.0"
 documentation: ../../Sources/AssistantV2/README.md
 readme: ../../Sources/AssistantV2/README.md
 build_tool_arguments:

diff --git a/Scripts/jazzy-config/CompareComplyV1.jazzy.yaml b/Scripts/jazzy-config/CompareComplyV1.jazzy.yaml
@@ -4,7 +4,7 @@ github_url: https://github.com/watson-developer-cloud/swift-sdk
 clean: true
 output: ../../gh-pages/services/CompareComplyV1
 module: CompareComplyV1
-module_version: "3.6.0"
+module_version: "4.0.0"
 documentation: ../../Sources/CompareComplyV1/README.md
 readme: ../../Sources/CompareComplyV1/README.md
 build_tool_arguments:

diff --git a/Scripts/jazzy-config/DiscoveryV1.jazzy.yaml b/Scripts/jazzy-config/DiscoveryV1.jazzy.yaml
@@ -4,7 +4,7 @@ github_url: https://github.com/watson-developer-cloud/swift-sdk
 clean: true
 output: ../../gh-pages/services/DiscoveryV1
 module: DiscoveryV1
-module_version: "3.6.0"
+module_version: "4.0.0"
 documentation: ../../Sources/DiscoveryV1/README.md
 readme: ../../Sources/DiscoveryV1/README.md
 build_tool_arguments:

diff --git a/Scripts/jazzy-config/DiscoveryV2.jazzy.yaml b/Scripts/jazzy-config/DiscoveryV2.jazzy.yaml
@@ -4,7 +4,7 @@ github_url: https://github.com/watson-developer-cloud/swift-sdk
 clean: true
 output: ../../gh-pages/services/DiscoveryV2
 module: DiscoveryV2
-module_version: "3.6.0"
+module_version: "4.0.0"
 documentation: ../../Sources/DiscoveryV2/README.md
 readme: ../../Sources/DiscoveryV2/README.md
 build_tool_arguments:

diff --git a/Scripts/jazzy-config/LanguageTranslatorV3.jazzy.yaml b/Scripts/jazzy-config/LanguageTranslatorV3.jazzy.yaml
@@ -4,7 +4,7 @@ github_url: https://github.com/watson-developer-cloud/swift-sdk
 clean: true
 output: ../../gh-pages/services/LanguageTranslatorV3
 module: LanguageTranslatorV3
-module_version: "3.6.0"
+module_version: "4.0.0"
 documentation: ../../Sources/LanguageTranslatorV3/README.md
 readme: ../../Sources/LanguageTranslatorV3/README.md
 build_tool_arguments:

diff --git a/Scripts/jazzy-config/NaturalLanguageClassifierV1.jazzy.yaml b/Scripts/jazzy-config/NaturalLanguageClassifierV1.jazzy.yaml
@@ -4,7 +4,7 @@ github_url: https://github.com/watson-developer-cloud/swift-sdk
 clean: true
 output: ../../gh-pages/services/NaturalLanguageClassifierV1
 module: NaturalLanguageClassifierV1
-module_version: "3.6.0"
+module_version: "4.0.0"
 documentation: ../../Sources/NaturalLanguageClassifierV1/README.md
 readme: ../../Sources/NaturalLanguageClassifierV1/README.md
 build_tool_arguments:

diff --git a/Scripts/jazzy-config/NaturalLanguageUnderstandingV1.jazzy.yaml b/Scripts/jazzy-config/NaturalLanguageUnderstandingV1.jazzy.yaml
@@ -4,7 +4,7 @@ github_url: https://github.com/watson-developer-cloud/swift-sdk
 clean: true
 output: ../../gh-pages/services/NaturalLanguageUnderstandingV1
 module: NaturalLanguageUnderstandingV1
-module_version: "3.6.0"
+module_version: "4.0.0"
 documentation: ../../Sources/NaturalLanguageUnderstandingV1/README.md
 readme: ../../Sources/NaturalLanguageUnderstandingV1/README.md
 build_tool_arguments:

diff --git a/Scripts/jazzy-config/PersonalityInsightsV3.jazzy.yaml b/Scripts/jazzy-config/PersonalityInsightsV3.jazzy.yaml
@@ -4,7 +4,7 @@ github_url: https://github.com/watson-developer-cloud/swift-sdk
 clean: true
 output: ../../gh-pages/services/PersonalityInsightsV3
 module: PersonalityInsightsV3
-module_version: "3.6.0"
+module_version: "4.0.0"
 documentation: ../../Sources/PersonalityInsightsV3/README.md
 readme: ../../Sources/PersonalityInsightsV3/README.md
 build_tool_arguments:

diff --git a/Scripts/jazzy-config/SpeechToTextV1.jazzy.yaml b/Scripts/jazzy-config/SpeechToTextV1.jazzy.yaml
@@ -4,7 +4,7 @@ github_url: https://github.com/watson-developer-cloud/swift-sdk
 clean: true
 output: ../../gh-pages/services/SpeechToTextV1
 module: SpeechToTextV1
-module_version: "3.6.0"
+module_version: "4.0.0"
 documentation: ../../Sources/SpeechToTextV1/README.md
 readme: ../../Sources/SpeechToTextV1/README.md
 build_tool_arguments:

diff --git a/Scripts/jazzy-config/TextToSpeechV1.jazzy.yaml b/Scripts/jazzy-config/TextToSpeechV1.jazzy.yaml
@@ -4,7 +4,7 @@ github_url: https://github.com/watson-developer-cloud/swift-sdk
 clean: true
 output: ../../gh-pages/services/TextToSpeechV1
 module: TextToSpeechV1
-module_version: "3.6.0"
+module_version: "4.0.0"
 documentation: ../../Sources/TextToSpeechV1/README.md
 readme: ../../Sources/TextToSpeechV1/README.md
 build_tool_arguments:

diff --git a/Scripts/jazzy-config/ToneAnalyzerV3.jazzy.yaml b/Scripts/jazzy-config/ToneAnalyzerV3.jazzy.yaml
@@ -4,7 +4,7 @@ github_url: https://github.com/watson-developer-cloud/swift-sdk
 clean: true
 output: ../../gh-pages/services/ToneAnalyzerV3
 module: ToneAnalyzerV3
-module_version: "3.6.0"
+module_version: "4.0.0"
 documentation: ../../Sources/ToneAnalyzerV3/README.md
 readme: ../../Sources/ToneAnalyzerV3/README.md
 build_tool_arguments:

diff --git a/Scripts/jazzy-config/VisualRecognitionV3.jazzy.yaml b/Scripts/jazzy-config/VisualRecognitionV3.jazzy.yaml
@@ -4,7 +4,7 @@ github_url: https://github.com/watson-developer-cloud/swift-sdk
 clean: true
 output: ../../gh-pages/services/VisualRecognitionV3
 module: VisualRecognitionV3
-module_version: "3.6.0"
+module_version: "4.0.0"
 documentation: ../../Sources/VisualRecognitionV3/README.md
 readme: ../../Sources/VisualRecognitionV3/README.md
 build_tool_arguments:

diff --git a/Scripts/jazzy-config/VisualRecognitionV4.jazzy.yaml b/Scripts/jazzy-config/VisualRecognitionV4.jazzy.yaml
@@ -4,7 +4,7 @@ github_url: https://github.com/watson-developer-cloud/swift-sdk
 clean: true
 output: ../../gh-pages/services/VisualRecognitionV4
 module: VisualRecognitionV4
-module_version: "3.6.0"
+module_version: "4.0.0"
 documentation: ../../Sources/VisualRecognitionV4/README.md
 readme: ../../Sources/VisualRecognitionV4/README.md
 build_tool_arguments:

diff --git a/Sources/SupportingFiles/Shared.swift b/Sources/SupportingFiles/Shared.swift
@@ -44,7 +44,7 @@ internal struct Shared {
         static let icpPrefix = "icp-"
     }
 
-    static let sdkVersion = "3.6.0"
+    static let sdkVersion = "4.0.0"
 
     /// The "User-Agent" header to be sent with every RestRequest
     static let userAgent: String? = {