Set version tags on publish by MustafaJafar · Pull Request #1850 · ynput/ayon-core

MustafaJafar · 2026-05-20T16:45:17Z

Changelog Description

Add Tags Enum to integrator, it fetches the tags list from the project anatomy.
Add tags to version entity on integrator and hero integrator

Testing notes:

Set tags in publisher
Publish

…ator and hero integrator

BigRoy · 2026-05-20T19:59:17Z

Can we move the version tags setting of values into a separate plug-in, that can also be disabled, similar to @moonyuet 's work here: #1847

BigRoy

As stated above:

make sure it's a separate plug-in

But also:

make sure it can be disabled in settings
have it disabled by default so the attribute does not show in publisher UI.
if tags are already in versionData when it reaches this plug-in with the attribute def, then append the selected tags

The only change in integrator should be that it'd be able to take this data from instance.data and apply it to the version.

Later we may want to add profiles for defaults, but I don't think we should now. Because it'll open a can of worms of what may need to be adjustable (like which tags you might be allowed to select from per context and whatnot)

…-on-publish

MustafaJafar · 2026-05-21T13:58:50Z

The only change in integrator should be that it'd be able to take this data from instance.data and apply it to the version.

I'm currently depending on instance.data["versionData"]["tags"]
I'm now checking relying on instance.data["tags"].

edit: I checked tags in instance data, I only found we add them below representations. so dedicating the instance data tags for versions seems fine.

…https://github.com/ynput/ayon-core into enhancement/1673-yn-0458-set-version-tags-on-publish

…-on-publish

BigRoy

Seems to work as intended.

BigRoy

Just some convert to set nodes.

…https://github.com/ynput/ayon-core into enhancement/1673-yn-0458-set-version-tags-on-publish

…-on-publish

MustafaJafar · 2026-05-26T16:15:05Z

@iLLiCiTiT Thank you. let me know if there are further actions.

@BigRoy it's worth mentioning that the enum disappears if the project has no tags. is this the desired UX?

BigRoy

LGTM - didn't test again though.
Just one cosmetic change to the logged message.

iLLiCiTiT · 2026-06-02T08:22:39Z

+                )
+            # Error if not all are string.
+            if not all(isinstance(tag, str) for tag in tags):
+                raise PublishError(


Suggested change

raise PublishError(

raise KnownPublishError(

Isn't this recommendation wrong @iLLiCiTiT

seeing that KnownPublishError is 'deprecated', see:

ayon-core/client/ayon_core/pipeline/publish/publish_plugins.py

Lines 36 to 44 in 70b22b1

class KnownPublishError(Exception):

"""Publishing crashed because of known error.

Artist can't affect source of the error.

Deprecated:

Please use `PublishError` instead. Marked as deprecated 24/09/02.

"""

@iLLiCiTiT just checking?

Oh, I think that deprecation should be removed. Sometimes it makes sense to raise an error that doesn't have to have "user-friendly" message and title.

Can you give some example on how to use that one differently from PublishError?

Nope, I'm wrong, it just shows the message of the expcetion. In that case we don't have a way how to show generic user error message with PublishError.

I'd rather have more errors that are more descriptive, than less. So we should really be recommending KnownPublishError if that's the only one actually showing anything remotely useful to the user. I think always if we raise a dedicated error, even if obscure. Anything is better than "Not your fault" message - it's one of the bigger complaints I've been hearing over time. The not your fault message telling you nothing.

Anyway, let's make sure it's the one that is more descriptive to the user - and if that is KnownPublishError then use that. And also make sure it's not marked deprecated anymore.

KnownPublishError does what PublishError does by default.

The thing is that sometimes you want to write technical information for a dev to the message which probably should not be shown to an artist.

The thing is that sometimes you want to write technical information for a dev to the message which probably should not be shown to an artist.

I see - so both show the message, but one (which one?) allows to attach additional messages that are shown elsewhere? if so, where?

I see - so both show the message, but one (which one?) allows to attach additional messages that are shown elsewhere? if so, where?

No, I thought that KnownPublishError does not show the message to artist -> so you could write more technical information there, but I was wrong.

The point is PublishError should be used (because it does what KnownPublishError does) and KnownPublishErro is really deprecated. To add more information to the error we would have to modify pyblish, or publish report viewer.

…-on-publish

BigRoy · 2026-06-17T12:11:57Z

@MustafaJafar would be great if you can finish above comments 🙇‍♂️

MustafaJafar · 2026-06-17T16:13:15Z

@BigRoy I pushed changes and gave it another test run on my end and it worked.

Co-authored-by: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com>

iLLiCiTiT · 2026-07-03T13:01:31Z

+        if tags is not None:
+            # Check if tags is an iteratable.
+            if not isinstance(tags, (list, tuple, set)):
+                raise KnownPublishError(


Suggested change

raise KnownPublishError(

raise PublishError(

iLLiCiTiT · 2026-07-03T13:01:38Z

+                )
+            # Error if not all are string.
+            if not all(isinstance(tag, str) for tag in tags):
+                raise KnownPublishError(


Suggested change

raise KnownPublishError(

raise PublishError(

MustafaJafar added 2 commits May 20, 2026 18:12

Add Tags enum to integrator, and add tags to version entity on integr…

f089bea

…ator and hero integrator

Make Ruff Happy

de1995b

MustafaJafar requested review from BigRoy and iLLiCiTiT May 20, 2026 16:45

MustafaJafar self-assigned this May 20, 2026

MustafaJafar added the type: enhancement Improvement of existing functionality or minor addition label May 20, 2026

ynbot added the size/XS label May 20, 2026

BigRoy requested changes May 21, 2026

View reviewed changes

MustafaJafar linked an issue May 21, 2026 that may be closed by this pull request

YN-0458: Set version tags on publish #1673

Open

MustafaJafar added 2 commits May 21, 2026 15:43

Move tags enum into a separate plugin and make it optional.

3d85c26

remove debug line

2d29773

MustafaJafar requested a review from BigRoy May 21, 2026 13:46

Merge branch 'develop' into enhancement/1673-yn-0458-set-version-tags…

c3e7e8e

…-on-publish

MustafaJafar added 3 commits May 21, 2026 16:07

use instance.data instead of version data

b6f8bc0

Merge branch 'enhancement/1673-yn-0458-set-version-tags-on-publish' of …

045c223

…https://github.com/ynput/ayon-core into enhancement/1673-yn-0458-set-version-tags-on-publish

make ruff happy

1734ede

MustafaJafar commented May 21, 2026

View reviewed changes

Comment thread client/ayon_core/plugins/publish/integrate_hero_version.py Outdated

ynbot added this to PR reviewing May 21, 2026

ynbot moved this to Review In Progress in PR reviewing May 21, 2026

github-project-automation Bot moved this from Review In Progress to Change Requested in PR reviewing May 21, 2026

Merge branch 'develop' into enhancement/1673-yn-0458-set-version-tags…

f2fb865

…-on-publish

BigRoy reviewed May 21, 2026

View reviewed changes

Comment thread client/ayon_core/plugins/publish/collect_version_tags.py Outdated

ynbot moved this from Change Requested to Review In Progress in PR reviewing May 21, 2026

BigRoy reviewed May 21, 2026

View reviewed changes

Comment thread client/ayon_core/plugins/publish/collect_version_tags.py

Comment thread client/ayon_core/plugins/publish/integrate_hero_version.py Outdated

BigRoy reviewed May 21, 2026

View reviewed changes

Comment thread client/ayon_core/plugins/publish/collect_version_tags.py Outdated

BigRoy approved these changes May 21, 2026

View reviewed changes

github-project-automation Bot moved this from Review In Progress to Merge Requested in PR reviewing May 21, 2026

BigRoy reviewed May 21, 2026

View reviewed changes

Comment thread client/ayon_core/plugins/publish/collect_version_tags.py Outdated

Comment thread client/ayon_core/plugins/publish/collect_version_tags.py Outdated

Comment thread client/ayon_core/plugins/publish/collect_version_tags.py

MustafaJafar added 2 commits May 22, 2026 12:45

IntegrateAsset: fix typo in variable name

f114911

Merge branch 'enhancement/1673-yn-0458-set-version-tags-on-publish' of …

26bbd1d

…https://github.com/ynput/ayon-core into enhancement/1673-yn-0458-set-version-tags-on-publish

MustafaJafar requested a review from iLLiCiTiT May 22, 2026 10:46

iLLiCiTiT reviewed May 25, 2026

View reviewed changes

Comment thread client/ayon_core/plugins/publish/collect_version_tags.py

iLLiCiTiT reviewed May 25, 2026

View reviewed changes

Comment thread client/ayon_core/plugins/publish/collect_version_tags.py Outdated

iLLiCiTiT reviewed May 25, 2026

View reviewed changes

Comment thread client/ayon_core/plugins/publish/integrate_hero_version.py Outdated

iLLiCiTiT reviewed May 25, 2026

View reviewed changes

Comment thread client/ayon_core/plugins/publish/collect_version_tags.py

MustafaJafar added 2 commits May 26, 2026 18:39

Merge branch 'develop' into enhancement/1673-yn-0458-set-version-tags…

e6a343c

…-on-publish

Optimizations from code review

a6f13fc

MustafaJafar requested a review from iLLiCiTiT May 26, 2026 16:13

BigRoy approved these changes May 26, 2026

View reviewed changes

Comment thread client/ayon_core/plugins/publish/integrate.py Outdated

Comment thread client/ayon_core/plugins/publish/integrate.py Outdated

github-project-automation Bot moved this from Review In Progress to Merge Requested in PR reviewing May 26, 2026

ynbot moved this from Merge Requested to Review In Progress in PR reviewing May 26, 2026

iLLiCiTiT reviewed Jun 2, 2026

View reviewed changes

Comment thread client/ayon_core/plugins/publish/collect_version_tags.py Outdated

iLLiCiTiT reviewed Jun 2, 2026

View reviewed changes

Comment thread client/ayon_core/plugins/publish/integrate.py Outdated

iLLiCiTiT reviewed Jun 2, 2026

View reviewed changes

Comment thread client/ayon_core/plugins/publish/integrate_hero_version.py Outdated

Merge branch 'develop' into enhancement/1673-yn-0458-set-version-tags…

115cf21

…-on-publish

MustafaJafar added 4 commits June 17, 2026 18:50

IntegrateAsset: better log message

63a1342

Use KnownPublishError instead of PublishError

1002db7

Remove the type hint

7f68230

get the right instance data item versionTags

d0dad9e

MustafaJafar requested a review from iLLiCiTiT June 17, 2026 16:13

iLLiCiTiT reviewed Jun 30, 2026

View reviewed changes

Comment thread client/ayon_core/plugins/publish/integrate.py Outdated

Update client/ayon_core/plugins/publish/integrate.py

cd38c86

Co-authored-by: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com>

iLLiCiTiT reviewed Jul 3, 2026

View reviewed changes

	class KnownPublishError(Exception):
	"""Publishing crashed because of known error.

	Artist can't affect source of the error.

	Deprecated:
	Please use `PublishError` instead. Marked as deprecated 24/09/02.

	"""

Uh oh!

Conversation

MustafaJafar commented May 20, 2026

Changelog Description

Testing notes:

Uh oh!

BigRoy commented May 20, 2026

Uh oh!

BigRoy left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MustafaJafar commented May 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BigRoy left a comment

Choose a reason for hiding this comment

Uh oh!

BigRoy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MustafaJafar commented May 26, 2026

Uh oh!

BigRoy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iLLiCiTiT Jul 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iLLiCiTiT Jul 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

BigRoy commented Jun 17, 2026

Uh oh!

MustafaJafar commented Jun 17, 2026

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

BigRoy left a comment •

edited

Loading

MustafaJafar commented May 21, 2026 •

edited

Loading

iLLiCiTiT Jul 3, 2026 •

edited

Loading

iLLiCiTiT Jul 3, 2026 •

edited

Loading