Skip to content

Commit

Permalink
Restore files from docs/ dir
Browse files Browse the repository at this point in the history
  • Loading branch information
jbelkins committed Nov 21, 2023
1 parent 41c98da commit ee5fde7
Show file tree
Hide file tree
Showing 3 changed files with 79 additions and 0 deletions.
38 changes: 38 additions & 0 deletions Sources/Core/AWSSDKForSwift/Documentation.docc/development.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Development

_Note: these instructions are only applicable to developers of the SDK itself. To use the AWS SDK for Swift to access
various AWS services, follow the instructions in the project's main [README](../README.md)._

You can define a `local.properties` config file at the root of the project to modify build behavior.

An example config with the various properties is below:

```
# comma separated list of paths to `includeBuild()`
# This is useful for local development of smithy-swift in particular
compositeProjects=../smithy-swift
# comma separated list of services to exclude from generation from sdk-codegen. When not specified all services are generated
# specify service.VERSION matching the filenames in the models directory `aws-models -> service.VERSION.json`
excludeModels=rds-data.2018-08-01, groundstation.2019-05-23
# comma separated list of services to generate from sdk-codegen. When not specified all services are generated
# specify service.VERSION matching the filenames in the models directory `aws-models -> service.VERSION.json`.
onlyIncludeModels=lambda.2015-03-31
# when generating aws services build as a standalong project or not (rootProject = true)
buildStandaloneSdk=true
```

**Note:** If a service is specified in both `excludeModels` and `onlyIncludeModels`, it will be excluded from generation.


##### Building a single service
See the local.properties definition above to specify this in a config file.

```
>> ./gradlew -PonlyIncludeModels=lambda.2015-03-31 :sdk-codegen:build
```

##### Testing Locally
Testing generated services requires `ClientRuntime` of `smithy-swift` and `AWSClientRuntime` Swift packages.
16 changes: 16 additions & 0 deletions Sources/Core/AWSSDKForSwift/Documentation.docc/logging.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Logging

The AWS SDK for Swift uses SwiftLog for high performant logging. Many of our calls are issued to the `debug` level of output, which are disabled in the console by default. To see debug output to your console, you can add the following code to your application in a place where you know that the code will be called once and only once:
```swift
import ClientRuntime
SDKLoggingSystem.initialize(logLevel: .debug)
```

Alternatively, if you need finer grain control of instances of SwiftLog, you can call `SDKLoggingSystem.add` to control specific instances of the log handler. For example:
```swift
import ClientRuntime

SDKLoggingSystem.add(logHandlerFactory: S3ClientLogHandlerFactory(logLevel: .debug))
SDKLoggingSystem.add(logHandlerFactory: CRTClientEngineLogHandlerFactory(logLevel: .info))
SDKLoggingSystem.initialize()
```
25 changes: 25 additions & 0 deletions Sources/Core/AWSSDKForSwift/Documentation.docc/stability.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Stability of the AWS SDK for Swift

For information about maintenance and support of SDK major versions and their underlying dependencies, see the
following in the AWS SDKs and Tools Shared Configuration and Credentials Reference Guide:

* [AWS SDKs and Tools Maintenance Policy](https://docs.aws.amazon.com/credref/latest/refdocs/maint-policy.html)
* [AWS SDKs and Tools Version Support Matrix](https://docs.aws.amazon.com/credref/latest/refdocs/version-support-matrix.html)

## Qualifiers

Qualifiers for published artifacts

**`-alpha`** indicates:

* The SDK is not meant for production workloads. It is released solely for the purpose of getting feedback.
* The SDK is not yet feature complete. It may contain bugs and performance issues.
* Expect migration issues as APIs/types change.

**`-beta`** indicates:

* The SDK is not meant for production workloads.
* The SDK is feature complete. It may still contain bugs and performance issues.
* The APIs/types are mostly stabilized. It is still possible that future releases may cause migration issues.

NOTE: This corresponds to the "Developer Preview" phase of the maintenance policy linked above.

0 comments on commit ee5fde7

Please sign in to comment.