This repository was archived by the owner on Oct 16, 2026. It is now read-only.
Repository navigation
docs(crab_config): document migration versioning scheme in README #279
Open
Norbiros
wants to merge
1
commit into
main
Choose a base branch
from
docs/mention-migration-versioning-scheme
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -31,3 +31,21 @@ Version field name is defined in: `configurable.rs` under the name of const vari | |||||
| ### Core concepts | ||||||
| - **Node** - A node is a single value in the config tree. It can be a primitive type, a list, or a map. | ||||||
| - **Migration** - A migration is a function that takes a config and returns a new config. It is used to update the config to a new version. | ||||||
|
|
||||||
| ### Migration Version | ||||||
|
|
||||||
| > This documentation applies only for the CrabCraft project. For other projects, you can use any versioning scheme you like. | ||||||
|
|
||||||
| CrabCraft uses a strict versioning scheme for configuration migrations to ensure compatibility and safe upgrades. The format is: | ||||||
|
|
||||||
| ```txt | ||||||
| MAJOR.MINOR.PATCH-migration.<MIGRATION> | ||||||
| ``` | ||||||
|
|
||||||
| * **MAJOR.MINOR.PATCH** – Matches the version of the CrabCraft binary. | ||||||
| * **MIGRATION** – A sequential index representing a specific migration step for this binary version. Each migration transforms the config from one version to the next, allowing the system to safely apply incremental updates. | ||||||
|
Sanielia marked this conversation as resolved.
|
||||||
|
|
||||||
| Each migration should be placed in a separate file inside the `src/config/migrations/` directory. File names must follow this pattern: | ||||||
| ```txt | ||||||
| m_<MAJOR>_<MINOR>_<PATCH>_<MIGRATION>_<VERY SHORT DESCRIPTION>.rs | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| ``` | ||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.