Stop cloning aws-doc-sdk-examples repository in CI (#4300)

Author: ysaito1001

.github/workflows/ci.yml

@@ -69,11 +69,6 @@ jobs:
       with:
         repository: awslabs/aws-sdk-rust
         path: aws-sdk-rust
-    # The examples from aws-doc-sdk-examples are needed to see if smithy-rs changes break examples
-    - uses: actions/checkout@v4
-      with:
-        repository: awsdocs/aws-doc-sdk-examples
-        path: aws-doc-sdk-examples
     - name: Run ${{ matrix.actions.action }}
       uses: ./smithy-rs/.github/actions/docker-build
       with:

aws/codegen-aws-sdk/src/main/kotlin/software/amazon/smithy/rustsdk/AwsCrateDocsDecorator.kt

@@ -150,7 +150,7 @@ internal class AwsCrateDocGenerator(private val codegenContext: ClientCodegenCon
                 #### Getting Started
 
                 > Examples are available for many services and operations, check out the
-                > [examples folder in GitHub](https://github.com/awslabs/aws-sdk-rust/tree/main/examples).
+                > [usage examples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1).
 
                 The SDK provides one crate per AWS service. You must add [Tokio](https://crates.io/crates/tokio)
                 as a dependency within your Rust project to execute asynchronous code. To add `$moduleName` to
@@ -209,7 +209,7 @@ internal class AwsCrateDocGenerator(private val codegenContext: ClientCodegenCon
                 * [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](https://github.com/awslabs/aws-sdk-rust/tree/main/examples)${"\n"}
+                * [Usage examples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1)${"\n"}
                 """.trimIndent(),
             )
 

aws/rust-runtime/aws-config/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "aws-config"
-version = "1.8.6"
+version = "1.8.7"
 authors = [
     "AWS Rust SDK Team <aws-sdk-rust@amazon.com>",
     "Russell Cohen <rcoh@amazon.com>",

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

@@ -31,7 +31,7 @@ async fn example() {
 
 ## Getting Started
 
-_Examples are available for many services and operations, check out the [examples folder in GitHub][Usage examples]._
+_Examples are available for many services and operations, check out the [Usage examples]._
 
 The SDK provides one crate per AWS service. You must add [Tokio] as a dependency within your Rust project to execute asynchronous code. To add aws-sdk-config to your project, add the following to your Cargo.toml file where VERSION is the version of the SDK you want to use:
 
@@ -58,13 +58,12 @@ Suggestions for additional sections or improvements for the guide are welcome. P
 
 This project is licensed under the Apache-2.0 License.
 
-[examples folder in GitHub]: https://github.com/awslabs/aws-sdk-rust/tree/main/examples
 [Tokio]: https://crates.io/crates/tokio
 [Guide]: https://github.com/awslabs/aws-sdk-rust/blob/main/Guide.md
 [GitHub discussions]: https://github.com/awslabs/aws-sdk-rust/discussions
 [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
+[Usage examples]: https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1
 
 <!-- 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/smithy-lang/smithy-rs) code generator.

aws/sdk/build.gradle.kts

@@ -38,7 +38,6 @@ val awsRustRuntimePath = rootProject.projectDir.resolve("aws/rust-runtime")
 val awsSdkPath = rootProject.projectDir.resolve("aws/sdk")
 val outputDir = layout.buildDirectory.dir("aws-sdk").get()
 val sdkOutputDir = outputDir.dir("sdk")
-val examplesOutputDir = outputDir.dir("examples")
 val checkedInSdkLockfile = rootProject.projectDir.resolve("aws/sdk/Cargo.lock")
 val generatedSdkLockfile = outputDir.file("Cargo.lock")
 
@@ -110,7 +109,6 @@ fun generateSmithyBuild(services: AwsServices): String {
                         "moduleVersion": "${crateVersioner.decideCrateVersion(moduleName, service)}",
                         "moduleAuthors": ["AWS Rust SDK Team <aws-sdk-rust@amazon.com>", "Russell Cohen <rcoh@amazon.com>"],
                         "moduleDescription": "${service.moduleDescription}",
-                        ${service.examplesUri(project)?.let { """"examples": "$it",""" } ?: ""}
                         "moduleRepository": "https://github.com/awslabs/aws-sdk-rust",
                         "license": "Apache-2.0",
                         "minimumSupportedRustVersion": "${getRustMSRV()}",
@@ -192,30 +190,6 @@ tasks.register("relocateServices") {
     outputs.dir(sdkOutputDir)
 }
 
-tasks.register("relocateExamples") {
-    description = "relocate the examples folder & rewrite path dependencies"
-    dependsOn("jar")
-
-    doLast {
-        if (awsServices.examples.isNotEmpty()) {
-            copy {
-                from(projectDir)
-                awsServices.examples.forEach { example ->
-                    include("$example/**")
-                }
-                into(outputDir)
-                exclude("**/target")
-                exclude("**/rust-toolchain.toml")
-                filter { line -> line.replace("build/aws-sdk/sdk/", "sdk/") }
-            }
-        }
-    }
-    if (awsServices.examples.isNotEmpty()) {
-        inputs.dir(projectDir.resolve("examples"))
-    }
-    outputs.dir(outputDir)
-}
-
 tasks.register("relocateTests") {
     description = "relocate the root integration tests and rewrite path dependencies"
     dependsOn("jar")
@@ -240,24 +214,6 @@ tasks.register("relocateTests") {
     outputs.dir(outputDir)
 }
 
-tasks.register<ExecRustBuildTool>("fixExampleManifests") {
-    description = "Adds dependency path and corrects version number of examples after relocation"
-    enabled = awsServices.examples.isNotEmpty()
-    dependsOn("relocateExamples")
-
-    toolPath = sdkVersionerToolPath
-    binaryName = "sdk-versioner"
-    arguments = listOf(
-        "use-path-and-version-dependencies",
-        "--sdk-path", sdkOutputDir.asFile.absolutePath,
-        "--versions-toml", outputDir.file("versions.toml").asFile.absolutePath,
-        outputDir.dir("examples").asFile.absolutePath,
-    )
-
-    outputs.dir(outputDir)
-    dependsOn("relocateExamples", "generateVersionManifest")
-}
-
 /**
  * The aws/rust-runtime crates depend on local versions of the Smithy core runtime enabling local compilation. However,
  * those paths need to be replaced in the final build. We should probably fix this with some symlinking.
@@ -336,9 +292,6 @@ tasks.register("generateCargoWorkspace") {
         rootProject.rootDir.resolve("clippy-root.toml").copyTo(outputDir.file("clippy.toml").asFile, overwrite = true)
     }
     inputs.property("servicelist", awsServices.moduleNames.toString())
-    if (awsServices.examples.isNotEmpty()) {
-        inputs.dir(projectDir.resolve("examples"))
-    }
     for (test in awsServices.rootTests) {
         inputs.dir(test.path)
     }
@@ -352,7 +305,6 @@ tasks.register<ExecRustBuildTool>("fixManifests") {
     dependsOn("relocateServices")
     dependsOn("relocateRuntime")
     dependsOn("relocateAwsRuntime")
-    dependsOn("relocateExamples")
     dependsOn("relocateTests")
 
     inputs.dir(publisherToolPath)
@@ -428,12 +380,10 @@ tasks.assemble.configure {
         "relocateServices",
         "relocateRuntime",
         "relocateAwsRuntime",
-        "relocateExamples",
         "relocateTests",
         "generateIndexMd",
         "fixManifests",
         "generateVersionManifest",
-        "fixExampleManifests",
         "hydrateReadme",
         "relocateChangelog",
     )

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

@@ -26,7 +26,8 @@ fun Project.docsLandingPage(
         write(
             "The AWS SDK for Rust contains one crate for each AWS service, as well as ${cratesIo("aws-config")} " +
                 "${docsRs("aws-config")}, a crate implementing configuration loading such as credential providers. " +
-                "For usage documentation see the [Developer Guide](https://docs.aws.amazon.com/sdk-for-rust/latest/dg/welcome.html).",
+                "For usage documentation see the [Developer Guide](https://docs.aws.amazon.com/sdk-for-rust/latest/dg/welcome.html). " +
+                "For code examples refer to the [Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1).",
         )
 
         writer.write("## AWS Services")
@@ -35,7 +36,7 @@ fun Project.docsLandingPage(
         writer.write("| Service | Package |")
         writer.write("| ------- | ------- |")
         awsServices.services.sortedBy { it.humanName }.forEach {
-            val items = listOfNotNull(cratesIo(it), docsRs(it), examplesLink(it, project)).joinToString(" ")
+            val items = listOfNotNull(cratesIo(it), docsRs(it)).joinToString(" ")
             writer.write(
                 "| ${it.humanName} | $items |",
             )
@@ -44,16 +45,6 @@ fun Project.docsLandingPage(
     outputPath.writeText(writer.toString())
 }
 
-/**
- * Generate a link to the examples for a given service
- */
-private fun examplesLink(
-    service: AwsService,
-    project: Project,
-) = service.examplesUri(project)?.let {
-    "([examples]($it))"
-}
-
 /**
  * Generate a link to the docs
  */

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

@@ -38,18 +38,10 @@ class AwsServices(
                 CrateSet.AWS_SDK_SMITHY_RUNTIME.map { "sdk/${it.name}" } +
                 CrateSet.AWS_SDK_RUNTIME.map { "sdk/${it.name}" }
             // Root tests should not be included since they can't be part of the root Cargo workspace
-            // in order to test differences in Cargo features. Examples should not be included either
-            // because each example itself is a workspace.
+            // in order to test differences in Cargo features.
         ).toSortedSet()
     }
 
-    val examples: List<String> by lazy {
-        val examplesRoot = project.projectDir.resolve("examples")
-        examplesRoot.listFiles { file ->
-            !file.name.startsWith(".") && file.isDirectory() && file.resolve("Cargo.toml").exists()
-        }.orEmpty().toList().map { "examples/${it.name}" }
-    }
-
     /**
      * Tests in `aws/sdk/integration-tests` that are not named after a service module, and therefore,
      * are not included in a service's `tests/` directory. These are to be included at the SDK root
@@ -88,7 +80,7 @@ class AwsServices(
     /**
      * Returns a list of crates excluded from the workspace.
      */
-    fun excludedFromWorkspace() = examples + rootTests.map(RootTest::manifestName)
+    fun excludedFromWorkspace() = rootTests.map(RootTest::manifestName)
 }
 
 /**
@@ -192,18 +184,6 @@ data class AwsService(
     val humanName: String,
 ) {
     fun modelFiles(): List<File> = listOf(modelFile) + extraFiles
-
-    fun Project.examples(): File = projectDir.resolve("examples").resolve(module)
-
-    /**
-     * Generate a link to the examples for a given service
-     */
-    fun examplesUri(project: Project) =
-        if (project.examples().exists()) {
-            "https://github.com/awslabs/aws-sdk-rust/tree/main/examples/$module"
-        } else {
-            null
-        }
 }
 
 fun AwsService.crate(): String = "aws-sdk-$module"

tools/ci-build/ci-create-workspace

@@ -28,7 +28,6 @@ cp -r "${SCRIPT_PATH}/../ci-scripts" "${ACTION_PATH}/workspace/"
 
 # Copy inputs into workspace
 for input_name in \
-    "aws-doc-sdk-examples" \
     "aws-sdk-rust" \
     "aws-sdk" \
     "aws-sdk-smoketest" \

tools/ci-scripts/generate-aws-sdk

@@ -21,11 +21,6 @@ if [[ ! -d "${AWS_SDK_MODELS_PATH}" ]]; then
   exit 1
 fi
 
-echo -e "${C_YELLOW}Taking examples from 'awsdocs/aws-doc-sdk-examples'...${C_RESET}"
-examples_revision=$(cd aws-doc-sdk-examples; git rev-parse HEAD)
-mv aws-doc-sdk-examples/rustv1 smithy-rs/aws/sdk/examples
-rm -rf smithy-rs/aws/sdk/examples/.cargo
-
 echo -e "${C_YELLOW}Creating empty model metadata file since we don't have model update information...${C_RESET}"
 MODEL_METADATA_PATH="$(pwd)/model-metadata.toml"
 echo > "${MODEL_METADATA_PATH}"
@@ -35,7 +30,6 @@ cd smithy-rs
 
 ./gradlew \
     -Paws.sdk.models.path="${AWS_SDK_MODELS_PATH}" \
-    -Paws.sdk.examples.revision="${examples_revision}" \
     -Paws.sdk.previous.release.versions.manifest="${PREVIOUS_RELEASE_VERSIONS_ARG}" \
     -Paws.sdk.model.metadata="${MODEL_METADATA_PATH}" \
     aws:sdk:assemble