GraphiteEditor / GraphiteEditor/Graphite

Node versioning system

Open
#2,084 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
27.2k
Forks
1.3k
Avg merge
20h 5m
Merged PRs (30d)
57

Description

Since nodes are constantly changing, we currently have to run automated upgrade scripts to replace node internals with the current version, update inputs, etc. A non destructive node versioning system similar to Crates is necessary for compatibility and ease of use.

Each instance of a node will store its version, and the document node definition will also store the version. The definition version will be incremented every time a node is changed, and every time a new version is created an upgrade script can be included to upgrade from the previous version to that version.

When the editor notices an out of date node, it prompts the user to upgrade it. It will use the mapping of version to upgrade scripts one by one to get the node to the most up to date version. The important part is that a node will never be automatically changed unless a user explicitly requests it. An ignore box should also be available, which dereferences the users node from the node definition.

Note that this is not related to editor structs and fields. That will still require breaking changes or best attempts at upgrading.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.