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

Support for community specific categories #27

Closed
KlutzyBubbles opened this issue Dec 12, 2023 · 2 comments · Fixed by #29
Closed

Support for community specific categories #27

KlutzyBubbles opened this issue Dec 12, 2023 · 2 comments · Fixed by #29

Comments

@KlutzyBubbles
Copy link

After raising an issue with tcli here. It looks to be an entirely different config option that this action doesnt support.

Perhaps an option like 'category_community' which will make

[publish.categories]
category_community=[categories]

instead of

[publish]
categories=[categories]

I havent actually tried tcli publish with the category community yet (i dont have any updates to publish). But i am confident based off of documentation and the issue that it will work.

@AnActualEmerald
Copy link
Member

Oh okay, I don't know how I missed that before

Seems weird to me that it would have to be explicit like that but whatever, I'll get a fix put together asap

@MythicManiac
Copy link

MythicManiac commented Dec 12, 2023

The CLI build supporting this syntax is only a few days old so that'd be why (the API has existed for a while now though).

Categories have always been bound to some individual community, it just hasn't been very obvious before since that community was implicitly derived from the domain that was used when uploading. That used to work fine before we started consolidating all communities under the same domain.

With all of that in mind, the category system really isn't suited well for this, I mean there's a reason they're not in the package metadata (since what categories exist are unique to each community). There's a rough idea on how this should work on a community-agnostic level, which would be something akin to tags which you can add to the package metadata directly.

Categories are intended as something the community can update later on & use for display purposes, whereas tags would be declared by the package author and remain immutable.

Notably, publishing a package with no categories set will not wipe the existing categories off of it, you only need to set them once. On the other hand, explicitly setting them when uploading a new version will remove all categories which were manually added after uploading. In that sense supporting categories in this action or the CLI at all might be a bit of a footgun, but perhaps one that should just be documented well rather than removed?

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 a pull request may close this issue.

3 participants