From d6317bc53f1487b6a2a6838177f0715871cd6227 Mon Sep 17 00:00:00 2001 From: psychedelicious <4822129+psychedelicious@users.noreply.github.com> Date: Mon, 4 Sep 2023 18:45:58 +1000 Subject: [PATCH] docs: update INVOCATIONS.md with version info --- docs/contributing/INVOCATIONS.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/contributing/INVOCATIONS.md b/docs/contributing/INVOCATIONS.md index b34a2f25ac..be5d9d0805 100644 --- a/docs/contributing/INVOCATIONS.md +++ b/docs/contributing/INVOCATIONS.md @@ -244,8 +244,12 @@ copy-paste the template above. We can use the `@invocation` decorator to provide some additional info to the UI, like a custom title, tags and category. +We also encourage providing a version. This must be a +[semver](https://semver.org/) version string ("$MAJOR.$MINOR.$PATCH"). The UI +will let users know if their workflow is using a mismatched version of the node. + ```python -@invocation("resize", title="My Resizer", tags=["resize", "image"], category="My Invocations") +@invocation("resize", title="My Resizer", tags=["resize", "image"], category="My Invocations", version="1.0.0") class ResizeInvocation(BaseInvocation): """Resizes an image""" @@ -279,8 +283,6 @@ take a look a at our [contributing nodes overview](contributingNodes). ## Advanced ---> - ### Custom Output Types Like with custom inputs, sometimes you might find yourself needing custom