Unverified Commit 08f6a8fa authored by ysaito1001's avatar ysaito1001 Committed by GitHub
Browse files

Treat `aws_doc_sdk_examples_revision` as optional (#4291)

parents 092cc0ac 5c7c9e28

aws/SDK_README.md.hb

+3 −3
Original line number Diff line number Diff line
@@ -21,7 +21,7 @@ The code used to generate the SDK can be found in [smithy-rs](https://github.com 


## Getting Started with the SDK



> Examples are available for many services and operations, check out the [examples folder](./examples).

> Examples are available for many services and operations, check out the [Rust examples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1) in the `aws-doc-sdk-examples` repository.



> For a step-by-step guide including several advanced use cases, check out the [Developer Guide](https://docs.aws.amazon.com/sdk-for-rust/latest/dg/welcome.html).
@@ -74,7 +74,7 @@ Suggestions for additional sections or improvements for the guide are welcome. P 
* [GitHub discussions](https://github.com/awslabs/aws-sdk-rust/discussions) - For ideas, RFCs & general questions

* [GitHub issues](https://github.com/awslabs/aws-sdk-rust/issues/new/choose) – For bug reports & feature requests

* [Generated Docs (latest version)](https://awslabs.github.io/aws-sdk-rust/)

* [Usage examples](./examples)

* [Usage examples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1)



## Feedback and Contributing
@@ -101,7 +101,7 @@ version will be called out in the Release Notes for new releases of the SDK. 


- Design docs - Design documentation for the SDK lives in the [design folder of smithy-rs](https://github.com/smithy-lang/smithy-rs/tree/main/design).

- Runtime / Handwritten code: The Rust Runtime code that underpins the SDK can be accessed [here](https://github.com/smithy-lang/smithy-rs/tree/main/rust-runtime) and [here](https://github.com/smithy-lang/smithy-rs/tree/main/aws/rust-runtime). This code is copied into this repo as part of code generation.

- [Code Examples](./examples)

- [Code Examples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1)

- [API reference documentation (rustdoc)](https://awslabs.github.io/aws-sdk-rust/)



## Security

aws/sdk/build.gradle.kts

+0 −2
Original line number Diff line number Diff line
@@ -405,8 +405,6 @@ tasks.register<ExecRustBuildTool>("generateVersionManifest") { 
        outputDir.asFile.absolutePath,

        "--smithy-build",

        layout.buildDirectory.file("smithy-build.json").get().asFile.normalize().absolutePath,

        "--examples-revision",

        properties.get("aws.sdk.examples.revision") ?: "missing",

    ).apply {

        getPreviousReleaseVersionManifestPath()?.let { manifestPath ->

            add("--previous-release-versions")

buildSrc/src/main/kotlin/aws/sdk/VersionsManifest.kt

+0 −2
Original line number Diff line number Diff line
@@ -18,7 +18,6 @@ data class CrateVersion( 
/** Kotlin representation of aws-sdk-rust's `versions.toml` file */

data class VersionsManifest(

    val smithyRsRevision: String,

    val awsDocSdkExamplesRevision: String,

    val crates: Map<String, CrateVersion>,

) {

    companion object {
@@ -31,7 +30,6 @@ data class VersionsManifest( 
            val toml = Toml().read(value)

            return VersionsManifest(

                smithyRsRevision = toml.getString("smithy_rs_revision"),

                awsDocSdkExamplesRevision = toml.getString("aws_doc_sdk_examples_revision"),

                crates =

                    toml.getTable("crates").entrySet().map { entry ->

                        val crate = (entry.value as Toml)

buildSrc/src/test/kotlin/aws/sdk/IndependentCrateVersionerTest.kt

+0 −4
Original line number Diff line number Diff line
@@ -32,7 +32,6 @@ class IndependentCrateVersionerTest { 
            IndependentCrateVersioner(

                VersionsManifest(

                    smithyRsRevision = "smithy-rs-1",

                    awsDocSdkExamplesRevision = "dontcare",

                    crates =

                        mapOf(

                            "aws-sdk-dynamodb" to
@@ -93,7 +92,6 @@ class IndependentCrateVersionerTest { 
            IndependentCrateVersioner(

                VersionsManifest(

                    smithyRsRevision = "smithy-rs-1",

                    awsDocSdkExamplesRevision = "dontcare",

                    crates =

                        mapOf(

                            "aws-sdk-dynamodb" to
@@ -161,7 +159,6 @@ class IndependentCrateVersionerTest { 
            IndependentCrateVersioner(

                VersionsManifest(

                    smithyRsRevision = "smithy-rs-1",

                    awsDocSdkExamplesRevision = "dontcare",

                    crates =

                        mapOf(

                            "aws-sdk-dynamodb" to
@@ -211,7 +208,6 @@ class IndependentCrateVersionerTest { 
            IndependentCrateVersioner(

                VersionsManifest(

                    smithyRsRevision = "smithy-rs-1",

                    awsDocSdkExamplesRevision = "dontcare",

                    crates =

                        mapOf(

                            "aws-sdk-dynamodb" to

buildSrc/src/test/kotlin/aws/sdk/VersionsManifestTest.kt

+0 −2
Original line number Diff line number Diff line
@@ -15,7 +15,6 @@ class VersionsManifestTest { 
            VersionsManifest.fromString(

                """

                smithy_rs_revision = 'some-smithy-rs-revision'

                aws_doc_sdk_examples_revision = 'some-doc-revision'



                [crates.aws-config]

                category = 'AwsRuntime'
@@ -31,7 +30,6 @@ class VersionsManifestTest { 
            )



        assertEquals("some-smithy-rs-revision", manifest.smithyRsRevision)

        assertEquals("some-doc-revision", manifest.awsDocSdkExamplesRevision)

        assertEquals(

            mapOf(

                "aws-config" to