chore: kickoff release

Author: atierian

.github/composite_actions/run_xcodebuild_test/action.yml

@@ -8,6 +8,9 @@ inputs:
   project_path:
     required: false
     type: string
+  xcode_path:
+    required: false
+    type: string
   destination:
     required: false
     type: string
@@ -28,7 +31,12 @@ runs:
       env:
         SCHEME: ${{ inputs.scheme }}
         PROJECT_PATH: ${{ inputs.project_path }}
+        XCODE_PATH: ${{ inputs.xcode_path }}
       run: |
         cd $PROJECT_PATH
-        xcodebuild test -scheme $SCHEME -sdk '${{ inputs.sdk }}' -destination '${{ inputs.destination }}' ${{ inputs.other_flags }} | xcpretty --simple --color --report junit && exit ${PIPESTATUS[0]}        
-      shell: bash 
+        if [ ! -z "$XCODE_PATH" ]; then
+          sudo xcode-select -s $XCODE_PATH
+        fi
+        xcodebuild -version
+        xcodebuild test -scheme $SCHEME -sdk '${{ inputs.sdk }}' -destination '${{ inputs.destination }}' ${{ inputs.other_flags }} | xcpretty --simple --color --report junit && exit ${PIPESTATUS[0]}
+      shell: bash

.github/workflows/integ_test_datastore.yml

@@ -6,15 +6,15 @@ on:
 
 permissions:
     id-token: write
-    contents: read 
+    contents: read
 
 concurrency:
   group: ${{ github.head_ref || github.run_id }}
   cancel-in-progress: true
 
 jobs:
   prepare-for-test:
-    runs-on: macos-12
+    runs-on: macos-13
     environment: IntegrationTest
     steps:
       - uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b
@@ -32,7 +32,7 @@ jobs:
   datastore-integration-test:
     timeout-minutes: 30
     needs: prepare-for-test
-    runs-on: macos-12
+    runs-on: macos-13
     environment: IntegrationTest
     steps:
       - uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b
@@ -55,5 +55,7 @@ jobs:
         with:
           project_path: ./AmplifyPlugins/DataStore/Tests/DataStoreHostApp
           scheme: AWSDataStorePluginIntegrationTests
+          destination: 'platform=iOS Simulator,name=iPhone 14,OS=latest'
+          xcode_path: '/Applications/Xcode_14.3.app'
+
 
- 

.github/workflows/integ_test_datastore_v2.yml

@@ -6,7 +6,7 @@ on:
 
 permissions:
     id-token: write
-    contents: read 
+    contents: read
 
 concurrency:
   group: ${{ github.head_ref || github.run_id }}
@@ -56,4 +56,4 @@ jobs:
           project_path: ./AmplifyPlugins/DataStore/Tests/DataStoreHostApp
           scheme: AWSDataStorePluginV2Tests
 
- 
+

.github/workflows/new_issue_maintainer.yml

@@ -10,7 +10,7 @@ permissions:
 jobs:
   maintainer-opened:
     runs-on: ubuntu-latest
-    if: ${{ !github.event.issue.pull_request && contains(fromJSON('["palpatim", "brennanMKE", "diegocstn", "lawmicha", "harsh62", "thisisabhash", "ameter", "royjit", "atierian", "ukhan-amazon", "ruisebas", "phantumcode"]'), github.event.issue.user.login) }}
+    if: ${{ !github.event.issue.pull_request && contains(fromJSON('["palpatim", "5d", "jcjimenez", "lawmicha", "harsh62", "thisisabhash", "royjit", "atierian", "ukhan-amazon", "ruisebas", "phantumcode"]'), github.event.issue.user.login) }}
     steps:
       - name: add message if maintainer opened
         shell: bash

.github/workflows/notify_issue_comment.yml

@@ -18,7 +18,7 @@ jobs:
     # The type of runner that the job will run on
     runs-on: ubuntu-latest
 
-    if: ${{ !github.event.issue.pull_request && !contains(fromJSON('["palpatim", "jcjimenez", "5d", "lawmicha", "harsh62", "thisisabhash", "ameter", "royjit", "atierian", "ukhan-amazon", "ruisebas", "phantumcode"]'), github.event.comment.user.login) }}
+    if: ${{ !github.event.issue.pull_request && !contains(fromJSON('["palpatim", "jcjimenez", "5d", "lawmicha", "harsh62", "thisisabhash", "royjit", "atierian", "ukhan-amazon", "ruisebas", "phantumcode"]'), github.event.comment.user.login) }}
 
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:

Amplify/Amplify.swift

@@ -18,27 +18,51 @@ import Foundation
 ///
 /// There are two exceptions to this. The `Logging` and `Hub` categories are configured with a default plugin that is
 /// available at initialization.
+///
+/// - Tag: Amplify
 public class Amplify {
 
     /// If `true`, `configure()` has already been invoked, and subsequent calls to `configure` will throw a
     /// ConfigurationError.amplifyAlreadyConfigured error.
+    ///
+    /// - Tag: Amplify.isConfigured
     static var isConfigured = false
 
     // Storage for the categories themselves, which will be instantiated during configuration, and cleared during reset.
     // It is not supported to mutate these category properties. They are `var` to support the `reset()` method for
     // ease of testing.
+
+    /// - Tag: Amplify.Analytics
     public static internal(set) var Analytics = AnalyticsCategory()
+
+    /// - Tag: Amplify.API
     public static internal(set) var API: APICategory = APICategory()
+
+    /// - Tag: Amplify.Auth
     public static internal(set) var Auth = AuthCategory()
+
+    /// - Tag: Amplify.DataStore
     public static internal(set) var DataStore = DataStoreCategory()
+
+    /// - Tag: Amplify.Geo
     public static internal(set) var Geo = GeoCategory()
+
+    /// - Tag: Amplify.Hub
     public static internal(set) var Hub = HubCategory()
+
+    /// - Tag: Amplify.Notifications
     public static internal(set) var Notifications = NotificationsCategory()
+
+    /// - Tag: Amplify.Predictions
     public static internal(set) var Predictions = PredictionsCategory()
+
+    /// - Tag: Amplify.Storage
     public static internal(set) var Storage = StorageCategory()
 
-    // Special case category. We protect this with an AtomicValue because it is used by reset()
-    // methods during setup & teardown of tests
+    /// Special case category. We protect this with an AtomicValue because it is used by reset()
+    /// methods during setup & teardown of tests
+    ///
+    /// - Tag: Amplify.Logging
     public static internal(set) var Logging: LoggingCategory {
         get {
             loggingAtomic.get()
@@ -51,7 +75,10 @@ public class Amplify {
 
     /// Adds `plugin` to the category
     ///
+    /// See: [Category.removePlugin(for:)](x-source-tag://Category.removePlugin)
+    ///
     /// - Parameter plugin: The plugin to add
+    /// - Tag: Amplify.add_plugin
     public static func add<P: Plugin>(plugin: P) throws {
         log.debug("Adding plugin: \(plugin))")
         switch plugin {

Amplify/Categories/Storage/Error/StorageError.swift

@@ -5,15 +5,56 @@
 // SPDX-License-Identifier: Apache-2.0
 //
 
+/// Errors thrown by implementations of the
+/// [StorageCategoryPlugin](x-source-tag://StorageCategoryPlugin) protocol.
+///
+/// - Tag: StorageError
 public enum StorageError {
+
+    /// Surfaced when a storage operation is attempted for either a file or a key to which the current user
+    /// does not have access.
+    ///
+    /// - Tag: StorageError.accessDenied
     case accessDenied(ErrorDescription, RecoverySuggestion, Error? = nil)
+
+    /// Surfaced when a storage operation is unable to resolve the current user.
+    ///
+    /// - Tag: StorageError.authError
     case authError(ErrorDescription, RecoverySuggestion, Error? = nil)
+
+    /// Surfaced when a storage plugin encounters an error during its configuration.
+    ///
+    /// - Tag: StorageError.configuration
     case configuration(ErrorDescription, RecoverySuggestion, Error? = nil)
+
+    /// Surfaced when a storage operation encounters an HTTP status code it considers an error.
+    ///
+    /// - Tag: StorageError.httpStatusError
     case httpStatusError(Int, RecoverySuggestion, Error? = nil)
+
+    /// Surfaced when a storage operation encounters an HTTP status code it considers an error.
+    ///
+    /// - Tag: StorageError.keyNotFound
     case keyNotFound(Key, ErrorDescription, RecoverySuggestion, Error? = nil)
+
+    /// Surfaced when a storage operation is unable to find a local file, usually when attempting to upload.
+    ///
+    /// - Tag: StorageError.localFileNotFound
     case localFileNotFound(ErrorDescription, RecoverySuggestion, Error? = nil)
+
+    /// Surfaced when a storage operation encounters an unexpected server-side error.
+    ///
+    /// - Tag: StorageError.service
     case service(ErrorDescription, RecoverySuggestion, Error? = nil)
+
+    /// Surfaced when a storage operation encounters an general unexpected error.
+    ///
+    /// - Tag: StorageError.unknown
     case unknown(ErrorDescription, Error? = nil)
+
+    /// Surfaced when a storage operation encounters invalid input.
+    ///
+    /// - Tag: StorageError.validation
     case validation(Field, ErrorDescription, RecoverySuggestion, Error? = nil)
 }
 

Amplify/Categories/Storage/Operation/Request/StorageGetURLRequest.swift

@@ -56,9 +56,11 @@ public extension StorageGetURLRequest {
         /// - Tag: StorageListRequestOptions.expires
         public let expires: Int
 
-        /// Extra plugin specific options, only used in special circumstances when the existing options do not provide
-        /// a way to utilize the underlying storage system's functionality. See plugin documentation for expected
-        /// key/values
+        /// Extra plugin specific options, only used in special circumstances when the existing options do
+        /// not provide a way to utilize the underlying storage system's functionality. See plugin
+        /// documentation or
+        /// [AWSStorageGetURLOptions](x-source-tag://AWSStorageGetURLOptions) for
+        /// expected key/values.
         ///
         /// - Tag: StorageListRequestOptions.pluginOptions
         public let pluginOptions: Any?

Amplify/Categories/Storage/Operation/StorageDownloadDataOperation.swift

@@ -7,6 +7,7 @@
 
 import Foundation
 
+/// - Tag: StorageDownloadDataOperation
 public protocol StorageDownloadDataOperation: AmplifyInProcessReportingOperation<
     StorageDownloadDataRequest,
     Progress,
@@ -19,6 +20,7 @@ public extension HubPayload.EventName.Storage {
     static let downloadData = "Storage.downloadData"
 }
 
+/// - Tag: StorageDownloadDataTask
 public typealias StorageDownloadDataTask = AmplifyInProcessReportingOperationTaskAdapter<StorageDownloadDataRequest,
                                                                                                   Progress,
                                                                                                   Data,

Amplify/Categories/Storage/Operation/StorageDownloadFileOperation.swift

@@ -16,6 +16,8 @@ import Foundation
 /// - Completed: `Void` - Receipt of a `.completed` event indicates the download is complete and the file has been
 ///   successfully stored to the local URL supplied in the original `StorageDownloadFileRequest`
 /// - Error: `StorageError` - Emitted if the download encounters an error.
+///
+/// - Tag: StorageDownloadFileOperation
 public protocol StorageDownloadFileOperation: AmplifyInProcessReportingOperation<
     StorageDownloadFileRequest,
     Progress,
@@ -28,6 +30,7 @@ public extension HubPayload.EventName.Storage {
     static let downloadFile = "Storage.downloadFile"
 }
 
+/// - Tag: StorageDownloadFileTask
 public typealias StorageDownloadFileTask = AmplifyInProcessReportingOperationTaskAdapter<StorageDownloadFileRequest,
                                                                                          Progress,
                                                                                          Void,