Skip to content
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.

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

Add registry metadata to published components. #132

Merged
merged 4 commits into from
Sep 6, 2023

Conversation

peterhuene
Copy link
Member

This PR adds registry metadata to components published to a registry with
cargo component publish and wit publish.

This commit adds registry metadata to components published with `cargo
component publish`.

Closes bytecodealliance#110.
This commit adds registry metadata to WIT packages published with `wit
publish`.

The data has been added as optional fields in `wit.toml`.
This fixes the duplicate updates of package logs when adding a registry
dependency via `wit add`.
metadata.set_description(config.description.clone());

// TODO: registry metadata should have keywords
// if !package.keywords.is_empty() {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are keywords distinct from categories? They seem coupled in the original registry discussion.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

crates.io has them as distinct fields, where keywords is for describing the package and the category with a set of predefined slugs to use.

I wasn't following the discussion around the metadata implementation closely, so it sounds like we should be populating this off of keywords instead of categories or perhaps both?

Copy link
Contributor

@fibonacci1729 fibonacci1729 Sep 5, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah! Given what you linked, i think distinct fields make the most sense (and AFAICT upon closer look seems to be what the registry discussion proposes). cc/ @Kylebrown9 to check my interpretation.

Copy link
Member Author

@peterhuene peterhuene Sep 5, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm going to switch to populating the categories field from the cargo keywords as I believe that's more of the intention of this field in the registry metadata; the predefined categories list from cargo doesn't map to what we'd want in a component registry anyway.

I've opened bytecodealliance/registry#197 to track the confusion here.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've decided to merge this as-is and wait for the resolution on the linked issue; will update cargo-component if things change.

@fibonacci1729
Copy link
Contributor

LGTM! Just a couple question to educate myself.

@peterhuene peterhuene merged commit aa6e3c1 into bytecodealliance:main Sep 6, 2023
@peterhuene peterhuene deleted the registry-metadata branch December 21, 2023 22:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants