Skip to content

Commit

Permalink
feat: ready for release candidate (#1578)
Browse files Browse the repository at this point in the history 
* chore: bump up packages version to RC

* docs: update README for RC

* fix: address feedbacks

Co-authored-by: Trivikram Kamat <[email protected]>
  • Loading branch information
@AllanZhengYP @trivikr
AllanZhengYP and trivikr authored Oct 19, 2020
1 parent 3430e34 commit 519f66c
Show file tree
Hide file tree
Showing 318 changed files with 7,237 additions and 7,237 deletions.
34 changes: 17 additions & 17 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# AWS SDK for JavaScript v3 gamma
# AWS SDK for JavaScript v3 RC

![Build Status](https://codebuild.us-west-2.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiMmtFajZWQmNUbEhidnBKN1VncjRrNVI3d0JUcFpGWUd3STh4T3N3Rnljc1BMaEIrYm9HU2t4YTV1RlE1YmlnUG9XM3luY0Ftc2tBc0xTeVFJMkVOa24wPSIsIml2UGFyYW1ldGVyU3BlYyI6IlBDMDl6UEROK1dlU1h1OWciLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master)
[![codecov](https://codecov.io/gh/aws/aws-sdk-js-v3/branch/master/graph/badge.svg)](https://codecov.io/gh/aws/aws-sdk-js-v3)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=aws/aws-sdk-js-v3)](https://dependabot.com)

The **AWS SDK for JavaScript v3 gamma** is a rewrite of V2 with some great new features. As with version 2, it enables you to easily work with [Amazon Web Services](https://aws.amazon.com/), but has been written in TypeScript and adds several frequently requested features, like modularized packages.
The **AWS SDK for JavaScript v3 RC** is a rewrite of V2 with some great new features. As with version 2, it enables you to easily work with [Amazon Web Services](https://aws.amazon.com/), but has been written in TypeScript and adds several frequently requested features, like modularized packages.

Many aspects of the SDK have been refactored and cleaned up, in addition to generating service client packages instead of hydrating services at SDK runtime. The v3 gamma is your chance to influence the direction of the new AWS SDK for JavaScript. Tell us what you like, tell us what you don’t like by [opening an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose). Your feedback matters to us.
Many aspects of the SDK have been refactored and cleaned up, in addition to generating service client packages instead of hydrating services at SDK runtime. The v3 RC is your chance to influence the direction of the new AWS SDK for JavaScript. Tell us what you like, tell us what you don’t like by [opening an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose). Your feedback matters to us.

## Production Readiness

This project is in gamma. We want feedback from you, and may make breaking changes in future releases while the SDK is still in gamma.
This project is a Release Candidate (RC). We want feedback from you. We will avoid breaking changes unless absolutely necessary.

The new AWS SDK for JavaScript will also be able to run alongside the version 2.x SDK in the same package to allow partial migration to the new product. As we get close to general availability for version 3, we’ll share a more detailed plan on how we’ll support the 2.x line.

Expand All @@ -20,7 +20,7 @@ The new AWS SDK for JavaScript will also be able to run alongside the version 2.
Let’s walk through setting up a project that depends on DynamoDB from the SDK and makes a simple service call. The following steps use yarn as an example. These steps assume you have Node.js and yarn already installed.

1. Create a new Node.js project.
2. Inside of the project, run: `yarn add @aws-sdk/client-dynamodb@gamma`. Adding packages results in update in [lock file](https://docs.npmjs.com/configuring-npm/package-locks.html), `yarn.lock` or `package-lock.json`. You **should** commit your lock file along with your code to avoid potential breaking changes.
2. Inside of the project, run: `yarn add @aws-sdk/client-dynamodb`. Adding packages results in update in [lock file](https://docs.npmjs.com/configuring-npm/package-locks.html), `yarn.lock` or `package-lock.json`. You **should** commit your lock file along with your code to avoid potential breaking changes.

3. Create a new file called index.js, create a DynamoDB service client and send a request.

Expand Down Expand Up @@ -66,21 +66,21 @@ In our workshop code, a lambda with DynamoDBClient and a command takes ~18kB whi

The SDK is now split up across multiple packages. The 2.x version of the SDK contained support for every service. This made it very easy to use multiple services in a project. Due to the limitations around reducing the size of the SDK when only using a handful of services or operations, many customers requested having separate packages for each service client. We have also split up the core parts of the SDK so that service clients only pull in what they need. For example, a service sends responses in JSON will no longer need to also have an XML parser as a dependency.

For those that were already importing services as sub-modules from the version 2.x SDK, the import statement doesn’t look too different. Here’s an example of importing the AWS Lambda service in version 2.0 of the SDK, and the gamma:
For those that were already importing services as sub-modules from the v2 SDK, the import statement doesn’t look too different. Here’s an example of importing the AWS Lambda service in v2 of the SDK, and the v3 SDK:

```javascript
// import the Lambda client constructor in version 2.0 of the SDK
// import the Lambda client constructor in v2 of the SDK
const Lambda = require("aws-sdk/clients/lambda");

// import the Lambda client constructor in version 3.0 gamma
// import the Lambda client constructor in v3 SDK
const { Lambda } = require("@aws-sdk/client-lambda");
```

It is also possible to import both versions of the Lambda client by changing the variable name the Lambda constructor is stored in.

### API changes

We’ve made several public API changes to improve consistency, make the SDK easier to use, and remove deprecated or confusing APIs. The following are some of the big changes included in the new AWS SDK for JavaScript v3 gamma.
We’ve made several public API changes to improve consistency, make the SDK easier to use, and remove deprecated or confusing APIs. The following are some of the big changes included in the new AWS SDK for JavaScript v3 rc.

#### Configuration

Expand All @@ -90,7 +90,7 @@ However, these configurations would first be merged automatically into a copy of
Also, calling `AWS.config.update({/* params *})` only updated configuration for service clients instantiated after the update call was made, not any existing clients.

This behavior was a frequent source of confusion, and made it difficult to add configuration to the global object that only affects a subset of service clients in a forward-compatible way.
In v3 gamma, there is no longer a global configuration managed by the SDK.
In v3 rc, there is no longer a global configuration managed by the SDK.
Configuration must be passed to each service client that is instantiated.
It is still possible to share the same configuration across multiple clients but that configuration will not be automatically merged with a global state.

Expand Down Expand Up @@ -152,26 +152,26 @@ All clients have been published to NPM and can be installed as described above.
yarn pack .
```

`yarn pack` will create an archive file in the client package folder, e.g. `aws-sdk-client-dynamodb-v1.0.0-gamma.1.tgz`.
`yarn pack` will create an archive file in the client package folder, e.g. `aws-sdk-client-dynamodb-v1.0.0-rc.1.tgz`.

1. Change directory to the project you are working on and move the archive to the location to store the vendor packages:

```
mv path/to/aws-sdk-js-v3/clients/client-dynamodb/aws-sdk-client-dynamodb-v1.0.0-gamma.1.tgz ./path/to/vendors/folder
mv path/to/aws-sdk-js-v3/clients/client-dynamodb/aws-sdk-client-dynamodb-v1.0.0-rc.1.tgz ./path/to/vendors/folder
```

1. Install the package to your project:

```
yarn add ./path/to/vendors/folder/aws-sdk-client-dynamodb-v1.0.0-gamma.1.tgz
yarn add ./path/to/vendors/folder/aws-sdk-client-dynamodb-v1.0.0-rc.1.tgz
```

### Giving feedback and contributing

You can provide feedback to us in several ways. Both positive and negative feedback is appreciated.
While the SDK is in gamma, you may encounter bugs while using it.
While the SDK is in RC, you may encounter bugs while using it.
If you do, please feel free to [open an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose) on our GitHub repository.
Our GitHub issues page also includes work we know still needs to be done before exiting the gamma state.
Our GitHub issues page also includes work we know still needs to be done before exiting the RC state.

#### Feedback

Expand All @@ -180,11 +180,11 @@ This is the preferred mechanism to give feedback so that other customers can eng
Issues you open will be evaluated, and included in our roadmap for the GA launch.

**Gitter channel**. For informal discussion or general feedback, you may join the [Gitter chat](https://gitter.im/aws/aws-sdk-js-v3).
The Gitter channel is also a great place to get help with v3 gamma from other developers. JS SDK team doesn't
The Gitter channel is also a great place to get help with v3 RC from other developers. JS SDK team doesn't
track the discussion daily, so feel free to open a GitHub issue if your question is not answered there.

#### Contributing

You can open pull requests for fixes or additions to the new AWS SDK for JavaScript v3 gamma.
You can open pull requests for fixes or additions to the new AWS SDK for JavaScript v3 RC.
All pull requests must be submitted under the Apache 2.0 license and will be reviewed by an SDK team member prior to merging.
Accompanying unit tests are appreciated. See [Contributing](CONTRIBUTING.md) for more information.
60 changes: 30 additions & 30 deletions clients/client-accessanalyzer/package.json
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@aws-sdk/client-accessanalyzer",
"description": "@aws-sdk/client-accessanalyzer client",
"version": "1.0.0-gamma.11",
"version": "1.0.0-rc.0",
"scripts": {
"clean": "npm run remove-definitions && npm run remove-dist",
"build-documentation": "npm run clean && typedoc ./",
Expand All @@ -28,39 +28,39 @@
"dependencies": {
"@aws-crypto/sha256-browser": "^1.0.0-alpha.0",
"@aws-crypto/sha256-js": "^1.0.0-alpha.0",
"@aws-sdk/config-resolver": "1.0.0-gamma.9",
"@aws-sdk/credential-provider-node": "1.0.0-gamma.9",
"@aws-sdk/fetch-http-handler": "1.0.0-gamma.10",
"@aws-sdk/hash-node": "1.0.0-gamma.8",
"@aws-sdk/invalid-dependency": "1.0.0-gamma.6",
"@aws-sdk/middleware-content-length": "1.0.0-gamma.8",
"@aws-sdk/middleware-host-header": "1.0.0-gamma.9",
"@aws-sdk/middleware-logger": "1.0.0-gamma.3",
"@aws-sdk/middleware-retry": "1.0.0-gamma.9",
"@aws-sdk/middleware-serde": "1.0.0-gamma.8",
"@aws-sdk/middleware-signing": "1.0.0-gamma.8",
"@aws-sdk/middleware-stack": "1.0.0-gamma.8",
"@aws-sdk/middleware-user-agent": "1.0.0-gamma.8",
"@aws-sdk/node-config-provider": "1.0.0-gamma.4",
"@aws-sdk/node-http-handler": "1.0.0-gamma.9",
"@aws-sdk/protocol-http": "1.0.0-gamma.8",
"@aws-sdk/smithy-client": "1.0.0-gamma.9",
"@aws-sdk/types": "1.0.0-gamma.7",
"@aws-sdk/url-parser-browser": "1.0.0-gamma.8",
"@aws-sdk/url-parser-node": "1.0.0-gamma.8",
"@aws-sdk/util-base64-browser": "1.0.0-gamma.7",
"@aws-sdk/util-base64-node": "1.0.0-gamma.7",
"@aws-sdk/util-body-length-browser": "1.0.0-gamma.7",
"@aws-sdk/util-body-length-node": "1.0.0-gamma.7",
"@aws-sdk/util-user-agent-browser": "1.0.0-gamma.8",
"@aws-sdk/util-user-agent-node": "1.0.0-gamma.9",
"@aws-sdk/util-utf8-browser": "1.0.0-gamma.7",
"@aws-sdk/util-utf8-node": "1.0.0-gamma.7",
"@aws-sdk/config-resolver": "1.0.0-rc.0",
"@aws-sdk/credential-provider-node": "1.0.0-rc.0",
"@aws-sdk/fetch-http-handler": "1.0.0-rc.0",
"@aws-sdk/hash-node": "1.0.0-rc.0",
"@aws-sdk/invalid-dependency": "1.0.0-rc.0",
"@aws-sdk/middleware-content-length": "1.0.0-rc.0",
"@aws-sdk/middleware-host-header": "1.0.0-rc.0",
"@aws-sdk/middleware-logger": "1.0.0-rc.0",
"@aws-sdk/middleware-retry": "1.0.0-rc.0",
"@aws-sdk/middleware-serde": "1.0.0-rc.0",
"@aws-sdk/middleware-signing": "1.0.0-rc.0",
"@aws-sdk/middleware-stack": "1.0.0-rc.0",
"@aws-sdk/middleware-user-agent": "1.0.0-rc.0",
"@aws-sdk/node-config-provider": "1.0.0-rc.0",
"@aws-sdk/node-http-handler": "1.0.0-rc.0",
"@aws-sdk/protocol-http": "1.0.0-rc.0",
"@aws-sdk/smithy-client": "1.0.0-rc.0",
"@aws-sdk/types": "1.0.0-rc.0",
"@aws-sdk/url-parser-browser": "1.0.0-rc.0",
"@aws-sdk/url-parser-node": "1.0.0-rc.0",
"@aws-sdk/util-base64-browser": "1.0.0-rc.0",
"@aws-sdk/util-base64-node": "1.0.0-rc.0",
"@aws-sdk/util-body-length-browser": "1.0.0-rc.0",
"@aws-sdk/util-body-length-node": "1.0.0-rc.0",
"@aws-sdk/util-user-agent-browser": "1.0.0-rc.0",
"@aws-sdk/util-user-agent-node": "1.0.0-rc.0",
"@aws-sdk/util-utf8-browser": "1.0.0-rc.0",
"@aws-sdk/util-utf8-node": "1.0.0-rc.0",
"tslib": "^2.0.0",
"uuid": "^3.0.0"
},
"devDependencies": {
"@aws-sdk/client-documentation-generator": "1.0.0-gamma.7",
"@aws-sdk/client-documentation-generator": "1.0.0-rc.0",
"@types/node": "^12.7.5",
"@types/uuid": "^3.0.0",
"jest": "^26.1.0",
Expand Down
60 changes: 30 additions & 30 deletions clients/client-acm-pca/package.json
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@aws-sdk/client-acm-pca",
"description": "@aws-sdk/client-acm-pca client",
"version": "1.0.0-gamma.11",
"version": "1.0.0-rc.0",
"scripts": {
"clean": "npm run remove-definitions && npm run remove-dist",
"build-documentation": "npm run clean && typedoc ./",
Expand All @@ -28,38 +28,38 @@
"dependencies": {
"@aws-crypto/sha256-browser": "^1.0.0-alpha.0",
"@aws-crypto/sha256-js": "^1.0.0-alpha.0",
"@aws-sdk/config-resolver": "1.0.0-gamma.9",
"@aws-sdk/credential-provider-node": "1.0.0-gamma.9",
"@aws-sdk/fetch-http-handler": "1.0.0-gamma.10",
"@aws-sdk/hash-node": "1.0.0-gamma.8",
"@aws-sdk/invalid-dependency": "1.0.0-gamma.6",
"@aws-sdk/middleware-content-length": "1.0.0-gamma.8",
"@aws-sdk/middleware-host-header": "1.0.0-gamma.9",
"@aws-sdk/middleware-logger": "1.0.0-gamma.3",
"@aws-sdk/middleware-retry": "1.0.0-gamma.9",
"@aws-sdk/middleware-serde": "1.0.0-gamma.8",
"@aws-sdk/middleware-signing": "1.0.0-gamma.8",
"@aws-sdk/middleware-stack": "1.0.0-gamma.8",
"@aws-sdk/middleware-user-agent": "1.0.0-gamma.8",
"@aws-sdk/node-config-provider": "1.0.0-gamma.4",
"@aws-sdk/node-http-handler": "1.0.0-gamma.9",
"@aws-sdk/protocol-http": "1.0.0-gamma.8",
"@aws-sdk/smithy-client": "1.0.0-gamma.9",
"@aws-sdk/types": "1.0.0-gamma.7",
"@aws-sdk/url-parser-browser": "1.0.0-gamma.8",
"@aws-sdk/url-parser-node": "1.0.0-gamma.8",
"@aws-sdk/util-base64-browser": "1.0.0-gamma.7",
"@aws-sdk/util-base64-node": "1.0.0-gamma.7",
"@aws-sdk/util-body-length-browser": "1.0.0-gamma.7",
"@aws-sdk/util-body-length-node": "1.0.0-gamma.7",
"@aws-sdk/util-user-agent-browser": "1.0.0-gamma.8",
"@aws-sdk/util-user-agent-node": "1.0.0-gamma.9",
"@aws-sdk/util-utf8-browser": "1.0.0-gamma.7",
"@aws-sdk/util-utf8-node": "1.0.0-gamma.7",
"@aws-sdk/config-resolver": "1.0.0-rc.0",
"@aws-sdk/credential-provider-node": "1.0.0-rc.0",
"@aws-sdk/fetch-http-handler": "1.0.0-rc.0",
"@aws-sdk/hash-node": "1.0.0-rc.0",
"@aws-sdk/invalid-dependency": "1.0.0-rc.0",
"@aws-sdk/middleware-content-length": "1.0.0-rc.0",
"@aws-sdk/middleware-host-header": "1.0.0-rc.0",
"@aws-sdk/middleware-logger": "1.0.0-rc.0",
"@aws-sdk/middleware-retry": "1.0.0-rc.0",
"@aws-sdk/middleware-serde": "1.0.0-rc.0",
"@aws-sdk/middleware-signing": "1.0.0-rc.0",
"@aws-sdk/middleware-stack": "1.0.0-rc.0",
"@aws-sdk/middleware-user-agent": "1.0.0-rc.0",
"@aws-sdk/node-config-provider": "1.0.0-rc.0",
"@aws-sdk/node-http-handler": "1.0.0-rc.0",
"@aws-sdk/protocol-http": "1.0.0-rc.0",
"@aws-sdk/smithy-client": "1.0.0-rc.0",
"@aws-sdk/types": "1.0.0-rc.0",
"@aws-sdk/url-parser-browser": "1.0.0-rc.0",
"@aws-sdk/url-parser-node": "1.0.0-rc.0",
"@aws-sdk/util-base64-browser": "1.0.0-rc.0",
"@aws-sdk/util-base64-node": "1.0.0-rc.0",
"@aws-sdk/util-body-length-browser": "1.0.0-rc.0",
"@aws-sdk/util-body-length-node": "1.0.0-rc.0",
"@aws-sdk/util-user-agent-browser": "1.0.0-rc.0",
"@aws-sdk/util-user-agent-node": "1.0.0-rc.0",
"@aws-sdk/util-utf8-browser": "1.0.0-rc.0",
"@aws-sdk/util-utf8-node": "1.0.0-rc.0",
"tslib": "^2.0.0"
},
"devDependencies": {
"@aws-sdk/client-documentation-generator": "1.0.0-gamma.7",
"@aws-sdk/client-documentation-generator": "1.0.0-rc.0",
"@types/node": "^12.7.5",
"jest": "^26.1.0",
"rimraf": "^3.0.0",
Expand Down
60 changes: 30 additions & 30 deletions clients/client-acm/package.json
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@aws-sdk/client-acm",
"description": "@aws-sdk/client-acm client",
"version": "1.0.0-gamma.11",
"version": "1.0.0-rc.0",
"scripts": {
"clean": "npm run remove-definitions && npm run remove-dist",
"build-documentation": "npm run clean && typedoc ./",
Expand All @@ -28,38 +28,38 @@
"dependencies": {
"@aws-crypto/sha256-browser": "^1.0.0-alpha.0",
"@aws-crypto/sha256-js": "^1.0.0-alpha.0",
"@aws-sdk/config-resolver": "1.0.0-gamma.9",
"@aws-sdk/credential-provider-node": "1.0.0-gamma.9",
"@aws-sdk/fetch-http-handler": "1.0.0-gamma.10",
"@aws-sdk/hash-node": "1.0.0-gamma.8",
"@aws-sdk/invalid-dependency": "1.0.0-gamma.6",
"@aws-sdk/middleware-content-length": "1.0.0-gamma.8",
"@aws-sdk/middleware-host-header": "1.0.0-gamma.9",
"@aws-sdk/middleware-logger": "1.0.0-gamma.3",
"@aws-sdk/middleware-retry": "1.0.0-gamma.9",
"@aws-sdk/middleware-serde": "1.0.0-gamma.8",
"@aws-sdk/middleware-signing": "1.0.0-gamma.8",
"@aws-sdk/middleware-stack": "1.0.0-gamma.8",
"@aws-sdk/middleware-user-agent": "1.0.0-gamma.8",
"@aws-sdk/node-config-provider": "1.0.0-gamma.4",
"@aws-sdk/node-http-handler": "1.0.0-gamma.9",
"@aws-sdk/protocol-http": "1.0.0-gamma.8",
"@aws-sdk/smithy-client": "1.0.0-gamma.9",
"@aws-sdk/types": "1.0.0-gamma.7",
"@aws-sdk/url-parser-browser": "1.0.0-gamma.8",
"@aws-sdk/url-parser-node": "1.0.0-gamma.8",
"@aws-sdk/util-base64-browser": "1.0.0-gamma.7",
"@aws-sdk/util-base64-node": "1.0.0-gamma.7",
"@aws-sdk/util-body-length-browser": "1.0.0-gamma.7",
"@aws-sdk/util-body-length-node": "1.0.0-gamma.7",
"@aws-sdk/util-user-agent-browser": "1.0.0-gamma.8",
"@aws-sdk/util-user-agent-node": "1.0.0-gamma.9",
"@aws-sdk/util-utf8-browser": "1.0.0-gamma.7",
"@aws-sdk/util-utf8-node": "1.0.0-gamma.7",
"@aws-sdk/config-resolver": "1.0.0-rc.0",
"@aws-sdk/credential-provider-node": "1.0.0-rc.0",
"@aws-sdk/fetch-http-handler": "1.0.0-rc.0",
"@aws-sdk/hash-node": "1.0.0-rc.0",
"@aws-sdk/invalid-dependency": "1.0.0-rc.0",
"@aws-sdk/middleware-content-length": "1.0.0-rc.0",
"@aws-sdk/middleware-host-header": "1.0.0-rc.0",
"@aws-sdk/middleware-logger": "1.0.0-rc.0",
"@aws-sdk/middleware-retry": "1.0.0-rc.0",
"@aws-sdk/middleware-serde": "1.0.0-rc.0",
"@aws-sdk/middleware-signing": "1.0.0-rc.0",
"@aws-sdk/middleware-stack": "1.0.0-rc.0",
"@aws-sdk/middleware-user-agent": "1.0.0-rc.0",
"@aws-sdk/node-config-provider": "1.0.0-rc.0",
"@aws-sdk/node-http-handler": "1.0.0-rc.0",
"@aws-sdk/protocol-http": "1.0.0-rc.0",
"@aws-sdk/smithy-client": "1.0.0-rc.0",
"@aws-sdk/types": "1.0.0-rc.0",
"@aws-sdk/url-parser-browser": "1.0.0-rc.0",
"@aws-sdk/url-parser-node": "1.0.0-rc.0",
"@aws-sdk/util-base64-browser": "1.0.0-rc.0",
"@aws-sdk/util-base64-node": "1.0.0-rc.0",
"@aws-sdk/util-body-length-browser": "1.0.0-rc.0",
"@aws-sdk/util-body-length-node": "1.0.0-rc.0",
"@aws-sdk/util-user-agent-browser": "1.0.0-rc.0",
"@aws-sdk/util-user-agent-node": "1.0.0-rc.0",
"@aws-sdk/util-utf8-browser": "1.0.0-rc.0",
"@aws-sdk/util-utf8-node": "1.0.0-rc.0",
"tslib": "^2.0.0"
},
"devDependencies": {
"@aws-sdk/client-documentation-generator": "1.0.0-gamma.7",
"@aws-sdk/client-documentation-generator": "1.0.0-rc.0",
"@types/node": "^12.7.5",
"jest": "^26.1.0",
"rimraf": "^3.0.0",
Expand Down
Loading

0 comments on commit 519f66c

Please sign in to comment.