Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add supported Rust versions to README #130

Merged
merged 1 commit into from
Jun 23, 2021
Merged

Add supported Rust versions to README #130

merged 1 commit into from
Jun 23, 2021

Conversation

jdisanti
Copy link
Contributor

Fixes #129.
Fixes #128.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@jdisanti jdisanti requested a review from rcoh June 23, 2021 22:43
Copy link
Contributor

@rcoh rcoh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you also add a badge to the top of the README? Something like: https://img.shields.io/badge/msrv-1.52.1-red

README.md Outdated
@@ -75,6 +75,10 @@ If you are interested in contributing to the new AWS SDK for Rust, please take a

This alpha SDK currently does not provide support for every AWS service. You can see all the services currently supported on [AWS_SERVICES_SUPPORTED](AWS_SERVICES_SUPPORTED.md)

## Supported Rust Versions

The SDK currently requires a minimum of Rust 1.51.0, and is not guaranteed to build on compiler versions earlier than that. While we are still in alpha, we will be keeping the minimum compiler version two releases behind the latest stable release (so if the latest stable is 1.53, we will be on 1.51), but we are not making any guarantees around this at present. Increases in minimum required Rust version will be called out in the Release Notes for new releases of the SDK.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's actually 1.52.0 because of a usage of some doc lints. We can roll it back if we want

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd include the string MSRV somewhere, that's what I'd search for if I was trying to figure this out

@jdisanti jdisanti requested a review from rcoh June 23, 2021 23:42
@rcoh rcoh merged commit e242dfe into awslabs:main Jun 23, 2021
@jdisanti jdisanti deleted the readme-msrv branch July 6, 2021 18:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants