Skip to content

Commit d6317bc

Browse files
docs: update INVOCATIONS.md with version info
1 parent 4aca264 commit d6317bc

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/contributing/INVOCATIONS.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -244,8 +244,12 @@ copy-paste the template above.
244244
We can use the `@invocation` decorator to provide some additional info to the
245245
UI, like a custom title, tags and category.
246246

247+
We also encourage providing a version. This must be a
248+
[semver](https://semver.org/) version string ("$MAJOR.$MINOR.$PATCH"). The UI
249+
will let users know if their workflow is using a mismatched version of the node.
250+
247251
```python
248-
@invocation("resize", title="My Resizer", tags=["resize", "image"], category="My Invocations")
252+
@invocation("resize", title="My Resizer", tags=["resize", "image"], category="My Invocations", version="1.0.0")
249253
class ResizeInvocation(BaseInvocation):
250254
"""Resizes an image"""
251255

@@ -279,8 +283,6 @@ take a look a at our [contributing nodes overview](contributingNodes).
279283

280284
## Advanced
281285

282-
-->
283-
284286
### Custom Output Types
285287

286288
Like with custom inputs, sometimes you might find yourself needing custom

0 commit comments

Comments
 (0)