Initial support for tags and extra metadata on components #309
Conversation
| * | ||
| * @param tags Various string values that will be propagated to the Showkase browser to allow additional | ||
| * filtering or categorization. | ||
| * @param extraMetadata Various string values that are **not** propagated through the Showkase browser |
There was a problem hiding this comment.
Add more information about how it's primarily meant to add more information for custom use cases that you might have
| componentKDoc = "", | ||
| componentKey = """com.airbnb.android.showkase_processor_testing_null_group_name_0_null""", | ||
| isDefaultStyle = false, | ||
| tags = listOf("tag A", "tag B"), |
There was a problem hiding this comment.
you want the extra metadata to be available here as well no?
There was a problem hiding this comment.
Oops I missed that the other classes were internal 🤦
pmecho
force-pushed
the
pe--tag-and-metadata-support
branch
from
c596824
to
edc4f1d
Compare
There was a problem hiding this comment.
@vinaygaba I also can't seem to get CI to fully pass. These jobs never start and I don't see a way to manually start them.
| @@ -80,6 +87,8 @@ interface ShowkaseScreenshotTest { | |||
| name: String, | |||
| group: String, | |||
| styleName: String? = null, | |||
| tags: List<String> = emptyList(), | |||
There was a problem hiding this comment.
@vinaygaba Are you okay with adding the tags and metadata here as well? We need this for correct attribution of our screenshots since we will likely have duplicate group/name/styleName and are using the extraMetadata to handle additional categorization.
This would also be a breaking change.
This starts the support for adding generic strings to tag and label components to help with filtering and custom categorization. Tags are added to the browser for filtering while metadata is only accessible from the generated
ShowkaseCodegenMetadataobject. A follow-up PR will add visual tag filtering to the built in browser.