Skip to content
This repository was archived by the owner on Oct 16, 2026. It is now read-only.

docs(crab_config): document migration versioning scheme in README - #279

Open
Norbiros wants to merge 1 commit into
mainfrom
docs/mention-migration-versioning-scheme
Open

Norbiros wants to merge 1 commit into
mainfrom
docs/mention-migration-versioning-scheme

Conversation

@Norbiros

Copy link
Copy Markdown
Member

No description provided.

@Norbiros
Norbiros force-pushed the docs/mention-migration-versioning-scheme branch from 4ea7844 to a7c823d Compare November 28, 2025 15:54
Comment thread crates/crab_config/README.md Outdated
Comment thread crates/crab_config/README.md
@Norbiros
Norbiros force-pushed the docs/mention-migration-versioning-scheme branch from a7c823d to dc6a14a Compare November 28, 2025 16:23

@Sanielia Sanielia left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

VERY SHORT APPROVE MESSAGE

@SzczurekYT SzczurekYT left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two suggestions that can make this better imo, no other regards


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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
m_<MAJOR>_<MINOR>_<PATCH>_<MIGRATION>_<VERY SHORT DESCRIPTION>.rs
m_<MAJOR>_<MINOR>_<PATCH>_<MIGRATION>_<VERY_SHORT_DESCRIPTION>.rs

- **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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Migration Version
### CrabCraft Migration Version
Suggested change
### Migration Version
### Migration Version (CrabCraft)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants