Skip to content

Commit

Permalink
Merge pull request #1 from aws/master
Browse files Browse the repository at this point in the history
Update with master
  • Loading branch information
Jerry Kindall authored Jul 29, 2020
2 parents 916706b + 2a48495 commit 57a469e
Show file tree
Hide file tree
Showing 1,326 changed files with 39,181 additions and 9,520 deletions.
1 change: 1 addition & 0 deletions .gitallowed
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ account: '234567890123'
# Account patterns used in the README
account: '000000000000'
account: '111111111111'
account: '222222222222'
account: '333333333333'

# used in physical names tests in @aws-cdk/core
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/general-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: "\U00002753 General Issue"
about: Create a new issue
title: "[module] "
labels: needs-triage
labels: needs-triage, guidance
---

<!-- NOTE:📕 If there is an issue regarding developer guide, please create an issue [here](https://github.com/awsdocs/aws-cdk-guide/issues) -->
Expand Down
193 changes: 97 additions & 96 deletions .github/workflows/issue-label-assign.yml

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ coverage/
*.sw[a-z]
*~
.idea
junit.xml

# We don't want tsconfig at the root
/tsconfig.json
Expand All @@ -38,3 +39,4 @@ yarn-error.log

# Parcel default cache directory
.parcel-cache

2 changes: 1 addition & 1 deletion .gitpod.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
image: jsii/superchain
tasks:
- init: yarn build --skip-test --no-bail
- init: yarn build --skip-test --no-bail --skip-prereqs --skip-compat

vscode:
extensions:
Expand Down
203 changes: 203 additions & 0 deletions CHANGELOG.md

Large diffs are not rendered by default.

29 changes: 14 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,26 +77,25 @@ you need to have the following SDKs and tools locally:
- [Node.js >= 10.13.0](https://nodejs.org/download/release/latest-v10.x/)
- We recommend using a version in [Active LTS](https://nodejs.org/en/about/releases/)
- ⚠️ versions `13.0.0` to `13.6.0` are not supported due to compatibility issues with our dependencies.
- [Yarn >= 1.19.1](https://yarnpkg.com/lang/en/docs/install)
- [Java OpenJDK 8](https://docs.aws.amazon.com/corretto/latest/corretto-8-ug/downloads-list.html)
- [Apache Maven](http://maven.apache.org/install.html)
- [.NET Core SDK 3.1](https://www.microsoft.com/net/download)
- [Python 3.6.5](https://www.python.org/downloads/release/python-365/)
- [Ruby 2.5.1](https://www.ruby-lang.org/en/news/2018/03/28/ruby-2-5-1-released/)
- [Yarn >= 1.19.1, < 1.3](https://yarnpkg.com/lang/en/docs/install)
- [Java >= OpenJDK 8, 11, 14](https://docs.aws.amazon.com/corretto/latest/corretto-8-ug/downloads-list.html)
- [Apache Maven >= 3.6.0, < 4.0](http://maven.apache.org/install.html)
- [.NET Core SDK 3.1.x](https://www.microsoft.com/net/download)
- [Python >= 3.6.5, < 4.0](https://www.python.org/downloads/release/python-365/)
- [Ruby >= 2.5.1, < 3.0](https://www.ruby-lang.org/en/news/2018/03/28/ruby-2-5-1-released/)
- [Docker 19.03](https://docs.docker.com/get-docker/)

The basic commands to get the repository cloned and built locally follow:

```console
$ git clone https://github.com/aws/aws-cdk.git
$ cd aws-cdk
$ yarn install
$ yarn build
```

If you get compiler errors when building, a common cause is globally installed tools like tslint and typescript. Try uninstalling them.
If you get compiler errors when building, a common cause is a globally installed typescript. Try uninstalling it.

```
npm uninstall -g tslint
npm uninstall -g typescript
```

Expand Down Expand Up @@ -143,6 +142,9 @@ Sometimes, the GitHub issue is sufficient for such discussions, and can be suffi
clarity on what you plan to do. Sometimes, a design document would work better, so people can provide
iterative feedback.

Before starting on a design, read through the [design guidelines](DESIGN_GUIDELINES.md) for general
patterns and tips.

In such cases, use the GitHub issue description to collect **requirements** and
**use cases** for your feature.

Expand Down Expand Up @@ -277,7 +279,7 @@ However, in many cases, you can probably get away with just building a portion o
want to work on.

We recommend that you use [Visual Studio Code](https://code.visualstudio.com/) to work on the CDK. Be sure to install
the [tslint extension](https://marketplace.visualstudio.com/items?itemName=eg2.tslint) for it as well, since we have
the [eslint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) for it as well, since we have
strict linting rules that will prevent your code from compiling, but with VSCode and this extension can be automatically
fixed for you by hitting `Ctrl-.` when your cursor is on a red underline.

Expand Down Expand Up @@ -332,9 +334,6 @@ The following linters are used -

#### eslint

Historically, the CDK has used tslint for linting its typescript source code. With [tslint's deprecation in
2019](https://medium.com/palantir/tslint-in-2019-1a144c2317a9), we are slowly moving over to using eslint.

All packages in the repo use a standard base configuration found at [eslintrc.js](tools/cdk-build-tools/config/eslintrc.js).
This can be customized for any package by modifying the `.eslintrc` file found at its root.

Expand Down Expand Up @@ -362,14 +361,14 @@ $ lr pkglint

**awslint** is a linter for the AWS Construct Library APIs. It is executed as a
part of the build of all AWS modules in the project and enforces the [AWS
Construct Library Design Guidelines](./design/aws-guidelines.md).
Construct Library Design Guidelines](./DESIGN_GUIDELINES.md).

For more information about this tool, see the [awslint
README](./tools/awslint/README.md).

Generally speaking, if you make any changes which violate an awslint rule, build
will fail with appropriate messages. All rules are documented and explained in
the [guidelines](./design/aws-guidelines.md).
the [guidelines](./DESIGN_GUIDELINES.md).

Here are a few useful commands:

Expand Down
Loading

0 comments on commit 57a469e

Please sign in to comment.