1.0.5 publishing on debug and release variants only

[bryantJB]

As of 1.0.5 it seems that the issue behind pull request #291 has come back.
We use a "mock" build type that was working with 1.0.4
A snippet from the error:

Variant 'debugVariantMaven***Publication' declares a library:

• Incompatible because this component declares a component for use during compile-time, as well as attribute 'com.android.build.api.attributes.BuildTypeAttr' with value 'debug' and the consumer needed a component for use during runtime, as well as attribute 'com.android.build.api.attributes.BuildTypeAttr' with value 'mock'
  This also gives errors for releaseVariantMaven***Publication
  with *** being JavaDoc, Runtime, Source, and Api
  This leads me to believe that showkase is once again being published with debug and release variants

[vinaygaba]

@bryantJB Interesting. As #291 never merged, I think the issue you are describing is related but probably not exactly that.

This leads me to believe that showkase is once again being published with debug and release variants

I don't think this ever changed as that PR never merged.

I'm happy to accept a contribution or implement it even if you can describe/recommend the correct setup I should be using as per this library that I use for publishing the library itself - https://github.com/vanniktech/gradle-maven-publish-plugin

[DevHugo]

I you looked the diff between 1.04.module and 1.05.module, you can see many differences.

Each of the versions declared an attribute on 1.0.5, that was not there in 1.0.4:

 "variants": [
  {
    "name": "debugVariantMavenApiPublication",
    "attributes": {
      "com.android.build.api.attributes.BuildTypeAttr": "debug"
      (other attrs redacted for clarity ...)
    },
  }
]

and I think that the issue, it explained in this medium in more details : https://proandroiddev.com/fixing-dependency-metadata-in-gradle-65fd86abe4e1. There is also a workaround.

It also matched the stacktrace, I got when I tried to compile with variant :

No matching variant of com.airbnb.android:showkase:1.0.5 was found. The consumer was configured to find a library for use during runtime, preferably optimized for Android, as well as attribute 'com.android.build.api.attributes.AgpVersionAttr' with value '8.13.0', attribute 'com.android.build.api.attributes.BuildTypeAttr' with value 'OtherVariant', attribute 'org.jetbrains.kotlin.platform.type' with value 'androidJvm' but:
- Variant 'debugVariantMavenApiPublication' declares a library:
- Incompatible because this component declares a component for use during compile-time, as well as attribute 'com.android.build.api.attributes.BuildTypeAttr' with value 'debug' and the consumer needed a component for use during runtime, as well as attribute 'com.android.build.api.attributes.BuildTypeAttr' with value 'OtherVariant'
- Other compatible attributes:
- Doesn't say anything about com.android.build.api.attributes.AgpVersionAttr (required '8.13.0')
- Doesn't say anything about com.android.build.api.attributes.ProductFlavor:retailer (required 'cb_plus')
- Doesn't say anything about its target Java environment (preferred optimized for Android)
- Doesn't say anything about org.jetbrains.kotlin.platform.type (required 'androidJvm')
(other messages redacted for clarity)

OtherVariant is the name of the variant in my project

You have a repro case project : https://github.com/DevHugo/ReproProjectShowkase.
You can try to compile the project with ./gradlew clean assembleDebug --rerun-tasks --no-configuration-cache and see that it works well but if you try to compile with ./gradlew clean assemblePaid --rerun-tasks --no-configuration-cache it will failed with the error

I can try to work on it this weekend but do not have time before. Feel free, if you want to work on it

[DevHugo]

I confirmed that the workaround in the article works well 🎉 .

build.kts :
https://gist.githubusercontent.com/popovanton0/f73631c6a819c630d543c10f8e42fff3/raw/628e0a267185d87cbc96936aaf7cf5507ebbeb1f/gradleMetadataRule.gradle.kts

groovy version :

/**
 * Explanation: https://popovanton0.medium.com/65fd86abe4e1
 */
@CacheableRule
class ShowkaseRule implements ComponentMetadataRule {

    @Override
    void execute(ComponentMetadataContext context) {
        requireSupportedVersion(context)

        MISSING_BUILD_TYPES.each { missingBuildType ->
            VARIANT_TEMPLATES.each { variantTemplate ->
                def newVariant = "${missingBuildType.name}${variantTemplate}"
                def baseVariant = "${missingBuildType.baseName}${variantTemplate}"

                // Create a new variant that copies `baseVariant` but has `newVariant` name
                context.details.addVariant(newVariant, baseVariant) { variant ->
                    variant.attributes { attrs ->
                        def buildTypeAttr = attrs.keySet().find { it.name == BUILD_TYPE_ATTR_NAME } as Attribute<String>
                        // add the attribute
                        attrs.attribute(buildTypeAttr, missingBuildType.name)
                    }
                }
            }
        }
    }

    private static void requireSupportedVersion(ComponentMetadataContext context) {
        if (context.details.id.toString() != 'com.airbnb.android:showkase:1.0.5') {
            throw new IllegalStateException(
                    'This rule works only for one particular version of the showkase library. ' +
                            'You need to test manually whether this rule works with other versions.'
            )
        }
    }

    static final class BuildType {
        final String name
        final String baseName
        BuildType(String name, String baseName) {
            this.name = name
            this.baseName = baseName
        }
    }

    private static final String BUILD_TYPE_ATTR_NAME = 'com.android.build.api.attributes.BuildTypeAttr'

    private static final List<BuildType> MISSING_BUILD_TYPES = [
            new BuildType('OtherVariant', 'debug')
    ]

    private static final List<String> VARIANT_TEMPLATES = [
            'VariantMavenApiPublication',
            'VariantMavenRuntimePublication',
            'VariantMavenSourcePublication',
            'VariantMavenJavaDocPublication',
    ]
}

dependencyResolutionManagement {
    components {
        withModule("com.airbnb.android:showkase", ShowkaseRule) {}
    }
}

Content must be placed in your settings file in the root of your project. Do not forget to change your OtherVariant by what's your variant is.

Taken from the article : https://proandroiddev.com/fixing-dependency-metadata-in-gradle-65fd86abe4e1

[bryantJB]

I confirmed that the workaround in the article works well 🎉 .

build.kts : https://gist.githubusercontent.com/popovanton0/f73631c6a819c630d543c10f8e42fff3/raw/628e0a267185d87cbc96936aaf7cf5507ebbeb1f/gradleMetadataRule.gradle.kts

gradle version :

/**
 * Explanation: https://popovanton0.medium.com/65fd86abe4e1
 */
@CacheableRule
class ShowkaseRule implements ComponentMetadataRule {

    @Override
    void execute(ComponentMetadataContext context) {
        requireSupportedVersion(context)

        MISSING_BUILD_TYPES.each { missingBuildType ->
            VARIANT_TEMPLATES.each { variantTemplate ->
                def newVariant = "${missingBuildType.name}${variantTemplate}"
                def baseVariant = "${missingBuildType.baseName}${variantTemplate}"

                // Create a new variant that copies `baseVariant` but has `newVariant` name
                context.details.addVariant(newVariant, baseVariant) { variant ->
                    variant.attributes { attrs ->
                        def buildTypeAttr = attrs.keySet().find { it.name == BUILD_TYPE_ATTR_NAME } as Attribute<String>
                        // add the attribute
                        attrs.attribute(buildTypeAttr, missingBuildType.name)
                    }
                }
            }
        }
    }

    private static void requireSupportedVersion(ComponentMetadataContext context) {
        if (context.details.id.toString() != 'com.airbnb.android:showkase:1.0.5') {
            throw new IllegalStateException(
                    'This rule works only for one particular version of the showkase library. ' +
                            'You need to test manually whether this rule works with other versions.'
            )
        }
    }

    static final class BuildType {
        final String name
        final String baseName
        BuildType(String name, String baseName) {
            this.name = name
            this.baseName = baseName
        }
    }

    private static final String BUILD_TYPE_ATTR_NAME = 'com.android.build.api.attributes.BuildTypeAttr'

    private static final List<BuildType> MISSING_BUILD_TYPES = [
            new BuildType('OtherVariant', 'debug')
    ]

    private static final List<String> VARIANT_TEMPLATES = [
            'VariantMavenApiPublication',
            'VariantMavenRuntimePublication',
            'VariantMavenSourcePublication',
            'VariantMavenJavaDocPublication',
    ]
}

dependencyResolutionManagement {
    components {
        withModule("com.airbnb.android:showkase", ShowkaseRule) {}
    }
}

Content must be placed in your settings file in the root of your project

Taken from the article : https://proandroiddev.com/fixing-dependency-metadata-in-gradle-65fd86abe4e1

Hey thanks! We'll give it a shot and mark this asap

[DevHugo]

@vinaygaba I tried something in this PR, can you give me your opinion ? #425