Define toolchain to override PackageMetadataInfo

docs/metadata/defs.md

@@ -47,6 +47,49 @@ Provider for declaring metadata about a Bazel package.
 | <a id="PackageMetadataInfo-files"></a>files | A [depset](https://bazel.build/rules/lib/builtins/depset) of [File](https://bazel.build/rules/lib/builtins/File)s with metadata about the package, including transitive files from all attributes of the package. | `[]` |
 
 
+<a id="PackageMetadataOverrideInfo"></a>
+
+## PackageMetadataOverrideInfo
+
+<pre>
+load("@package_metadata//:defs.bzl", "PackageMetadataOverrideInfo")
+
+PackageMetadataOverrideInfo(*, <a href="#PackageMetadataOverrideInfo-packages">packages</a>, <a href="#PackageMetadataOverrideInfo-metadata">metadata</a>)
+</pre>
+
+Defines an override for `PackageMetadataInfo` for a set of packages.
+
+> **Fields in this provider are not covered by the stability gurantee.**
+
+**FIELDS**
+
+| Name  | Description |
+| :------------- | :------------- |
+| <a id="PackageMetadataOverrideInfo-packages"></a>packages | A [PackageSpecificationInfo](https://bazel.build/rules/lib/providers/PackageSpecificationInfo) provider declaring which packages the override applies to.<br><br>This is typically created by a [package_group](https://bazel.build/rules/lib/globals/build#package_group) target. |
+| <a id="PackageMetadataOverrideInfo-metadata"></a>metadata | The `PackageMetadataInfo` provider to use instead of the provider declared by package itself. |
+
+
+<a id="PackageMetadataToolchainInfo"></a>
+
+## PackageMetadataToolchainInfo
+
+<pre>
+load("@package_metadata//:defs.bzl", "PackageMetadataToolchainInfo")
+
+PackageMetadataToolchainInfo(<a href="#PackageMetadataToolchainInfo-metadata_overrides">metadata_overrides</a>)
+</pre>
+
+Toolchain for `package_metadata`.
+
+> **Fields in this provider are not covered by the stability gurantee.**
+
+**FIELDS**
+
+| Name  | Description | Default Value |
+| :------------- | :------------- | :------------- |
+| <a id="PackageMetadataToolchainInfo-metadata_overrides"></a>metadata_overrides | A sequence of `PackageMetadataOverrideInfo` providers. | `[]` |
+
+
 <a id="package_metadata"></a>
 
 ## package_metadata
@@ -70,6 +113,27 @@ package_metadata(*, <a href="#package_metadata-name">name</a>, <a href="#package
 | <a id="package_metadata-visibility"></a>visibility |  <p align="center"> - </p>   |  `None` |
 
 
+<a id="package_metadata_toolchain"></a>
+
+## package_metadata_toolchain
+
+<pre>
+load("@package_metadata//:defs.bzl", "package_metadata_toolchain")
+
+package_metadata_toolchain(*, <a href="#package_metadata_toolchain-name">name</a>, <a href="#package_metadata_toolchain-visibility">visibility</a>)
+</pre>
+
+
+
+**PARAMETERS**
+
+
+| Name  | Description | Default Value |
+| :------------- | :------------- | :------------- |
+| <a id="package_metadata_toolchain-name"></a>name |  <p align="center"> - </p>   |  none |
+| <a id="package_metadata_toolchain-visibility"></a>visibility |  <p align="center"> - </p>   |  `None` |
+
+
 <a id="purl.bazel"></a>
 
 ## purl.bazel

docs/metadata/providers/BUILD

@@ -1,32 +1,26 @@
 load("@bazel_skylib//rules:diff_test.bzl", "diff_test")
 load("@stardoc//stardoc:stardoc.bzl", "stardoc")
 
-stardoc(
-    name = "package_attribute_info",
-    out = "package_attribute_info.generated.md",
-    input = "@package_metadata//providers:package_attribute_info.bzl",
-    deps = [
-        "@package_metadata//providers:srcs",
-    ],
-)
-
-diff_test(
-    name = "package_attribute_info_test",
-    file1 = ":package_attribute_info",
-    file2 = "package_attribute_info.md",
-)
-
-stardoc(
-    name = "package_metadata_info",
-    out = "package_metadata_info.generated.md",
-    input = "@package_metadata//providers:package_metadata_info.bzl",
-    deps = [
-        "@package_metadata//providers:srcs",
-    ],
-)
-
-diff_test(
-    name = "package_metadata_info_test",
-    file1 = ":package_metadata_info",
-    file2 = "package_metadata_info.md",
-)
+[
+    [
+        stardoc(
+            name = file,
+            out = "{}.generated.md".format(file),
+            input = "@package_metadata//providers:{}.bzl".format(file),
+            deps = [
+                "@package_metadata//providers:srcs",
+            ],
+        ),
+        diff_test(
+            name = "{}_test".format(file),
+            file1 = ":{}".format(file),
+            file2 = "{}.md".format(file),
+        ),
+    ]
+    for file in [
+        "package_attribute_info",
+        "package_metadata_info",
+        "package_metadata_override_info",
+        "package_metadata_toolchain_info",
+    ]
+]

docs/metadata/providers/package_metadata_override_info.md

@@ -0,0 +1,26 @@
+<!-- Generated with Stardoc: http://skydoc.bazel.build -->
+
+Declares provider `PackageMetadataOverrideInfo`.
+
+<a id="PackageMetadataOverrideInfo"></a>
+
+## PackageMetadataOverrideInfo
+
+<pre>
+load("@package_metadata//providers:package_metadata_override_info.bzl", "PackageMetadataOverrideInfo")
+
+PackageMetadataOverrideInfo(*, <a href="#PackageMetadataOverrideInfo-packages">packages</a>, <a href="#PackageMetadataOverrideInfo-metadata">metadata</a>)
+</pre>
+
+Defines an override for `PackageMetadataInfo` for a set of packages.
+
+> **Fields in this provider are not covered by the stability gurantee.**
+
+**FIELDS**
+
+| Name  | Description |
+| :------------- | :------------- |
+| <a id="PackageMetadataOverrideInfo-packages"></a>packages | A [PackageSpecificationInfo](https://bazel.build/rules/lib/providers/PackageSpecificationInfo) provider declaring which packages the override applies to.<br><br>This is typically created by a [package_group](https://bazel.build/rules/lib/globals/build#package_group) target. |
+| <a id="PackageMetadataOverrideInfo-metadata"></a>metadata | The `PackageMetadataInfo` provider to use instead of the provider declared by package itself. |
+
+

docs/metadata/providers/package_metadata_toolchain_info.md

@@ -0,0 +1,25 @@
+<!-- Generated with Stardoc: http://skydoc.bazel.build -->
+
+Declares provider `PackageMetadataToolchainInfo`.
+
+<a id="PackageMetadataToolchainInfo"></a>
+
+## PackageMetadataToolchainInfo
+
+<pre>
+load("@package_metadata//providers:package_metadata_toolchain_info.bzl", "PackageMetadataToolchainInfo")
+
+PackageMetadataToolchainInfo(<a href="#PackageMetadataToolchainInfo-metadata_overrides">metadata_overrides</a>)
+</pre>
+
+Toolchain for `package_metadata`.
+
+> **Fields in this provider are not covered by the stability gurantee.**
+
+**FIELDS**
+
+| Name  | Description | Default Value |
+| :------------- | :------------- | :------------- |
+| <a id="PackageMetadataToolchainInfo-metadata_overrides"></a>metadata_overrides | A sequence of `PackageMetadataOverrideInfo` providers. | `[]` |
+
+

docs/metadata/rules/BUILD

@@ -1,17 +1,24 @@
 load("@bazel_skylib//rules:diff_test.bzl", "diff_test")
 load("@stardoc//stardoc:stardoc.bzl", "stardoc")
 
-stardoc(
-    name = "package_metadata",
-    out = "package_metadata.generated.md",
-    input = "@package_metadata//rules:package_metadata.bzl",
-    deps = [
-        "@package_metadata//rules:srcs",
-    ],
-)
-
-diff_test(
-    name = "package_metadata_test",
-    file1 = ":package_metadata",
-    file2 = "package_metadata.md",
-)
+[
+    [
+        stardoc(
+            name = file,
+            out = "{}.generated.md".format(file),
+            input = "@package_metadata//rules:{}.bzl".format(file),
+            deps = [
+                "@package_metadata//rules:srcs",
+            ],
+        ),
+        diff_test(
+            name = "{}_test".format(file),
+            file1 = ":{}".format(file),
+            file2 = "{}.md".format(file),
+        ),
+    ]
+    for file in [
+        "package_metadata",
+        "package_metadata_toolchain",
+    ]
+]

docs/metadata/rules/package_metadata_toolchain.md

@@ -0,0 +1,25 @@
+<!-- Generated with Stardoc: http://skydoc.bazel.build -->
+
+Declares rule `package_metadata_toolchain`.
+
+<a id="package_metadata_toolchain"></a>
+
+## package_metadata_toolchain
+
+<pre>
+load("@package_metadata//rules:package_metadata_toolchain.bzl", "package_metadata_toolchain")
+
+package_metadata_toolchain(*, <a href="#package_metadata_toolchain-name">name</a>, <a href="#package_metadata_toolchain-visibility">visibility</a>)
+</pre>
+
+
+
+**PARAMETERS**
+
+
+| Name  | Description | Default Value |
+| :------------- | :------------- | :------------- |
+| <a id="package_metadata_toolchain-name"></a>name |  <p align="center"> - </p>   |  none |
+| <a id="package_metadata_toolchain-visibility"></a>visibility |  <p align="center"> - </p>   |  `None` |
+
+

metadata/defs.bzl

@@ -2,17 +2,23 @@
 
 load("//providers:package_attribute_info.bzl", _PackageAttributeInfo = "PackageAttributeInfo")
 load("//providers:package_metadata_info.bzl", _PackageMetadataInfo = "PackageMetadataInfo")
+load("//providers:package_metadata_override_info.bzl", _PackageMetadataOverrideInfo = "PackageMetadataOverrideInfo")
+load("//providers:package_metadata_toolchain_info.bzl", _PackageMetadataToolchainInfo = "PackageMetadataToolchainInfo")
 load("//purl:purl.bzl", _purl = "purl")
 load("//rules:package_metadata.bzl", _package_metadata = "package_metadata")
+load("//rules:package_metadata_toolchain.bzl", _package_metadata_toolchain = "package_metadata_toolchain")
 
 visibility("public")
 
 # Providers.
 PackageAttributeInfo = _PackageAttributeInfo
 PackageMetadataInfo = _PackageMetadataInfo
+PackageMetadataOverrideInfo = _PackageMetadataOverrideInfo
+PackageMetadataToolchainInfo = _PackageMetadataToolchainInfo
 
 # Rules
 package_metadata = _package_metadata
+package_metadata_toolchain = _package_metadata_toolchain
 
 # Utils
 purl = _purl

metadata/providers/BUILD

@@ -2,6 +2,8 @@ exports_files(
     [
         "package_attribute_info.bzl",
         "package_metadata_info.bzl",
+        "package_metadata_override_info.bzl",
+        "package_metadata_toolchain_info.bzl",
     ],
     visibility = ["//visibility:public"],
 )
@@ -11,6 +13,8 @@ filegroup(
     srcs = [
         "package_attribute_info.bzl",
         "package_metadata_info.bzl",
+        "package_metadata_override_info.bzl",
+        "package_metadata_toolchain_info.bzl",
     ],
     visibility = ["//visibility:public"],
 )

metadata/providers/package_metadata_override_info.bzl

@@ -0,0 +1,32 @@
+"""Declares provider `PackageMetadataOverrideInfo`."""
+
+visibility("public")
+
+def _init(*, packages, metadata):
+    return {
+        "metadata": metadata,
+        "packages": packages,
+    }
+
+PackageMetadataOverrideInfo, _create = provider(
+    doc = """
+Defines an override for `PackageMetadataInfo` for a set of packages.
+
+> **Fields in this provider are not covered by the stability gurantee.**
+""".strip(),
+    fields = {
+        "metadata": """
+The `PackageMetadataInfo` provider to use instead of the provider declared by
+package itself.
+""".strip(),
+        "packages": """
+A [PackageSpecificationInfo](https://bazel.build/rules/lib/providers/PackageSpecificationInfo)
+provider declaring which packages the override applies to.
+
+This is typically created by a
+[package_group](https://bazel.build/rules/lib/globals/build#package_group)
+target.
+""".strip(),
+    },
+    init = _init,
+)

metadata/providers/package_metadata_toolchain_info.bzl

@@ -0,0 +1,22 @@
+"""Declares provider `PackageMetadataToolchainInfo`."""
+
+visibility("public")
+
+def _init(metadata_overrides = []):
+    return {
+        "metadata_overrides": metadata_overrides,
+    }
+
+PackageMetadataToolchainInfo, _create = provider(
+    doc = """
+Toolchain for `package_metadata`.
+
+> **Fields in this provider are not covered by the stability gurantee.**
+""".strip(),
+    fields = {
+        "metadata_overrides": """
+A sequence of `PackageMetadataOverrideInfo` providers.
+""".strip(),
+    },
+    init = _init,
+)

metadata/rules/BUILD

@@ -1,6 +1,7 @@
 exports_files(
     [
         "package_metadata.bzl",
+        "package_metadata_toolchain.bzl",
     ],
     visibility = ["//visibility:public"],
 )
@@ -9,6 +10,7 @@ filegroup(
     name = "srcs",
     srcs = [
         "package_metadata.bzl",
+        "package_metadata_toolchain.bzl",
     ] + [
         "//providers:srcs",
     ],