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

add docs.rs metadata to only build on linux (#795)

parent 85c413f7

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

+6 −1
Original line number Diff line number Diff line
@@ -6,6 +6,8 @@ 
package software.amazon.smithy.rustsdk



import software.amazon.smithy.rust.codegen.smithy.RetryConfigDecorator

import software.amazon.smithy.rust.codegen.smithy.customizations.DocsRsMetadataDecorator

import software.amazon.smithy.rust.codegen.smithy.customizations.DocsRsMetadataSettings

import software.amazon.smithy.rust.codegen.smithy.customize.CombinedCodegenDecorator

import software.amazon.smithy.rustsdk.customize.apigateway.ApiGatewayDecorator

import software.amazon.smithy.rustsdk.customize.auth.DisabledAuthDecorator
@@ -37,7 +39,10 @@ val DECORATORS = listOf( 
    ApiGatewayDecorator(),

    S3Decorator(),

    Ec2Decorator(),

    GlacierDecorator()

    GlacierDecorator(),



    // Only build docs-rs for linux to reduce load on docs.rs

    DocsRsMetadataDecorator(DocsRsMetadataSettings(targets = listOf("x86_64-unknown-linux-gnu")))

)



class AwsCodegenDecorator : CombinedCodegenDecorator(DECORATORS) {

codegen/src/main/kotlin/software/amazon/smithy/rust/codegen/smithy/customizations/DocsRsMetadataDecorator.kt

0 → 100644
+58 −0
Original line number Diff line number Diff line 
/*

 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

 * SPDX-License-Identifier: Apache-2.0.

 */



package software.amazon.smithy.rust.codegen.smithy.customizations



import software.amazon.smithy.rust.codegen.smithy.CodegenContext

import software.amazon.smithy.rust.codegen.smithy.customize.RustCodegenDecorator

import software.amazon.smithy.rust.codegen.smithy.generators.ManifestCustomizations



/**

 * See https://docs.rs/about/metadata for more information

 */

data class DocsRsMetadataSettings(

    val features: List<String>? = null,

    val allFeatures: Boolean? = null,

    val noDefaultFeatures: Boolean? = null,

    val defaultTarget: String? = null,

    val targets: List<String>? = null,

    val rustcArgs: List<String>? = null,

    val rustdocArgs: List<String>? = null,

    val cargoArgs: List<String>? = null,

    /** Any custom key-value pairs to be inserted into the docsrs metadata */

    val custom: HashMap<String, Any> = HashMap()

)



fun DocsRsMetadataSettings.asMap(): Map<String, Any> {

    val inner = listOfNotNull(

        features?.let { "features" to it },

        allFeatures?.let { "all-features" to it },

        noDefaultFeatures?.let { "no-default-features" to it },

        defaultTarget?.let { "no-default-target" to it },

        targets?.let { "targets" to it },

        rustcArgs?.let { "rustc-args" to it },

        rustdocArgs?.let { "rustdoc-args" to it },

        cargoArgs?.let { "cargo-args" to it }

    ).toMap() + custom

    return mapOf("package" to mapOf("metadata" to mapOf("docs" to mapOf("rs" to inner))))

}



/**

 * Write docs.rs metdata settings into Cargo.toml

 *

 * docs.rs can be configured via data set at `[package.metadata.docs.rs]`. This decorator will write [DocsRsMetadataSettings]

 * into the appropriate location.

 *

 * # Notes

 * This decorator is not used by default, code generators must manually configure and include it in their builds.

 */

class DocsRsMetadataDecorator(private val docsRsMetadataSettings: DocsRsMetadataSettings) : RustCodegenDecorator {

    override val name: String = "docsrs-metadata"

    override val order: Byte = 0



    override fun crateManifestCustomizations(codegenContext: CodegenContext): ManifestCustomizations {

        return docsRsMetadataSettings.asMap()

    }

}