Skip to content

Add kind and purl to PackageMetadataInfo #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add kind and purl to PackageMetadataInfo #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions docs/metadata/defs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,19 +32,29 @@ Provider for declaring metadata about a Bazel package.
<pre>
load("@package_metadata//:defs.bzl", "PackageMetadataInfo")

PackageMetadataInfo(<a href="#PackageMetadataInfo-metadata">metadata</a>, <a href="#PackageMetadataInfo-files">files</a>)
PackageMetadataInfo(<a href="#PackageMetadataInfo-_init-metadata">metadata</a>, <a href="#PackageMetadataInfo-_init-purl">purl</a>, <a href="#PackageMetadataInfo-_init-files">files</a>)
</pre>

Provider for declaring metadata about a Bazel package.

> **Fields in this provider are not covered by the stability gurantee.**

**FIELDS**
**CONSTRUCTOR PARAMETERS**

| Name | Description | Default Value |
| :------------- | :------------- | :------------- |
| <a id="PackageMetadataInfo-metadata"></a>metadata | The [File](https://bazel.build/rules/lib/builtins/File) containing metadata about the package. | none |
| <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="PackageMetadataInfo-_init-metadata"></a>metadata | The [File](https://bazel.build/rules/lib/builtins/File) containing metadata about the package. | none |
| <a id="PackageMetadataInfo-_init-purl"></a>purl | PURL | none |
| <a id="PackageMetadataInfo-_init-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. | `[]` |

**FIELDS**

| Name | Description |
| :------------- | :------------- |
| <a id="PackageMetadataInfo-kind"></a>kind | Type descriminator |
| <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="PackageMetadataInfo-metadata"></a>metadata | The [File](https://bazel.build/rules/lib/builtins/File) containing metadata about the package. |
| <a id="PackageMetadataInfo-purl"></a>purl | PURL |


<a id="package_metadata"></a>
Expand Down
18 changes: 14 additions & 4 deletions docs/metadata/providers/package_metadata_info.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,28 @@ Declares provider `PackageMetadataInfo`.
<pre>
load("@package_metadata//providers:package_metadata_info.bzl", "PackageMetadataInfo")

PackageMetadataInfo(<a href="#PackageMetadataInfo-metadata">metadata</a>, <a href="#PackageMetadataInfo-files">files</a>)
PackageMetadataInfo(<a href="#PackageMetadataInfo-_init-metadata">metadata</a>, <a href="#PackageMetadataInfo-_init-purl">purl</a>, <a href="#PackageMetadataInfo-_init-files">files</a>)
</pre>

Provider for declaring metadata about a Bazel package.

> **Fields in this provider are not covered by the stability gurantee.**

**FIELDS**
**CONSTRUCTOR PARAMETERS**

| Name | Description | Default Value |
| :------------- | :------------- | :------------- |
| <a id="PackageMetadataInfo-metadata"></a>metadata | The [File](https://bazel.build/rules/lib/builtins/File) containing metadata about the package. | none |
| <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="PackageMetadataInfo-_init-metadata"></a>metadata | The [File](https://bazel.build/rules/lib/builtins/File) containing metadata about the package. | none |
| <a id="PackageMetadataInfo-_init-purl"></a>purl | PURL | none |
| <a id="PackageMetadataInfo-_init-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. | `[]` |

**FIELDS**

| Name | Description |
| :------------- | :------------- |
| <a id="PackageMetadataInfo-kind"></a>kind | Type descriminator |
| <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="PackageMetadataInfo-metadata"></a>metadata | The [File](https://bazel.build/rules/lib/builtins/File) containing metadata about the package. |
| <a id="PackageMetadataInfo-purl"></a>purl | PURL |


6 changes: 5 additions & 1 deletion metadata/providers/package_metadata_info.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,17 @@

visibility("public")

def _init(metadata, files = []):
def _init(metadata, purl, files = []):
return {
"kind": "build.bazel.attribute.package_metadata",
"files": depset(
direct = [
metadata,
],
transitive = files,
),
"metadata": metadata,
"purl": purl,
}

PackageMetadataInfo, _create = provider(
Expand All @@ -20,6 +22,7 @@ Provider for declaring metadata about a Bazel package.
> **Fields in this provider are not covered by the stability gurantee.**
""".strip(),
fields = {
"kind": """Type descriminator""",
"files": """
A [depset](https://bazel.build/rules/lib/builtins/depset) of
[File](https://bazel.build/rules/lib/builtins/File)s with metadata about the
Expand All @@ -29,6 +32,7 @@ package, including transitive files from all attributes of the package.
The [File](https://bazel.build/rules/lib/builtins/File) containing metadata
about the package.
""".strip(),
"purl": """PURL""",
},
init = _init,
)
1 change: 1 addition & 0 deletions metadata/rules/package_metadata.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ def _package_metadata_impl(ctx):
),
PackageMetadataInfo(
metadata = metadata,
purl = ctx.attr.purl,
files = [a.files for a in attributes],
),
]
Expand Down