Unverified Commit 35de48a2 authored by Russell Cohen's avatar Russell Cohen Committed by GitHub
Browse files

Add a few READMEs + linter script (#899) 



* Add a few READMEs + linter script

* Add initial linter script

* Add CI job

* Apply suggestions from code review

Co-authored-by: default avatarJohn DiSanti <jdisanti@amazon.com>

* Add README fix command

* Add newline in footer

* Add footer support to generator

* Also run fixes in CI

* Add note about smithy-types

* cleanups to scripts and READMEs

Co-authored-by: default avatarJohn DiSanti <jdisanti@amazon.com>
parent 4dc36bb1

.github/workflows/ci.yaml

+16 −0
Original line number Diff line number Diff line
@@ -13,6 +13,22 @@ env: 
  java_version: 11



jobs:

  repo-lint:

    name: smithy-rs custom repo lints

    runs-on: ubuntu-latest

    steps:

    - uses: actions/checkout@v2

    - uses: actions-rs/toolchain@v1

      with:

        toolchain: ${{ env.rust_version }}

        components: ${{ env.rust_toolchain_components }}

        default: true

    - run: cargo run -- check --all

      name: run checks

      working-directory: tools/sdk-lints

    - run: cargo run -- fix --all

      name: run fixes

      working-directory: tools/sdk-lints

  style:

    name: Kotlin style checks

    runs-on: ubuntu-latest

aws/rust-runtime/aws-config/README.md

+4 −0
Original line number Diff line number Diff line
@@ -66,3 +66,7 @@ This project is licensed under the Apache-2.0 License. 
[GitHub issues]: https://github.com/awslabs/aws-sdk-rust/issues/new/choose

[Generated Docs]: https://awslabs.github.io/aws-sdk-rust/

[Usage examples]: https://github.com/awslabs/aws-sdk-rust/tree/main/examples



<!-- anchor_start:footer -->

This crate is part of the [AWS SDK for Rust](https://awslabs.github.io/aws-sdk-rust/) and the [smithy-rs](https://github.com/awslabs/smithy-rs) code generator. In most cases, it should not be used directly.

<!-- anchor_end:footer -->

aws/rust-runtime/aws-endpoint/README.md

0 → 100644
+6 −0
Original line number Diff line number Diff line 
# aws-endpoint

This crate defines endpoint resolution logic specific to AWS services.



<!-- anchor_start:footer -->

This crate is part of the [AWS SDK for Rust](https://awslabs.github.io/aws-sdk-rust/) and the [smithy-rs](https://github.com/awslabs/smithy-rs) code generator. In most cases, it should not be used directly.

<!-- anchor_end:footer -->

aws/rust-runtime/aws-http/README.md

0 → 100644
+10 −0
Original line number Diff line number Diff line 
# aws-http



This crate provides middleware for AWS SDKs using HTTP including:

* Generalized retry policy

* Middleware for setting `User-Agent` headers based on runtime configuration

* Credential loading async middleware



<!-- anchor_start:footer -->

This crate is part of the [AWS SDK for Rust](https://awslabs.github.io/aws-sdk-rust/) and the [smithy-rs](https://github.com/awslabs/smithy-rs) code generator. In most cases, it should not be used directly.

<!-- anchor_end:footer -->

aws/rust-runtime/aws-hyper/README.md

0 → 100644
+10 −0
Original line number Diff line number Diff line 
# AWS Default Middleware



This crate defines the default middleware stack used by AWS services. It also provides a re-export

of `aws_smithy_client::Client` with the middleware type preset.



_Note:_ this crate will be removed in the future in favor of defining the middlewares directly in the service clients.



<!-- anchor_start:footer -->

This crate is part of the [AWS SDK for Rust](https://awslabs.github.io/aws-sdk-rust/) and the [smithy-rs](https://github.com/awslabs/smithy-rs) code generator. In most cases, it should not be used directly.

<!-- anchor_end:footer -->