Update documentation and CI to include world validation checks
Some checks failed
Smoke tests / Build and smoke test (push) Failing after 34s
Some checks failed
Smoke tests / Build and smoke test (push) Failing after 34s
- Added a note in AGENTS.md about using `mudtool validate -w ./world` for schema validation before committing. - Updated TESTING.md to include a checklist item for the new validation command. - Modified smoke-tests.yml to run the world validation command as part of the CI workflow.
This commit is contained in:
@@ -19,5 +19,8 @@ jobs:
|
|||||||
- name: Build
|
- name: Build
|
||||||
run: cargo build
|
run: cargo build
|
||||||
|
|
||||||
|
- name: Validate world data
|
||||||
|
run: ./target/debug/mudtool validate -w ./world
|
||||||
|
|
||||||
- name: Run smoke tests
|
- name: Run smoke tests
|
||||||
run: ./run-tests.sh
|
run: ./run-tests.sh
|
||||||
|
|||||||
@@ -131,6 +131,7 @@ src/
|
|||||||
2. NPCs without a `[combat]` section get default stats (20hp/4atk/2def/5xp)
|
2. NPCs without a `[combat]` section get default stats (20hp/4atk/2def/5xp)
|
||||||
3. Room IDs are `<region_dir>:<filename_stem>`
|
3. Room IDs are `<region_dir>:<filename_stem>`
|
||||||
4. Cross-region exits work — just reference the full ID
|
4. Cross-region exits work — just reference the full ID
|
||||||
|
5. Run `mudtool validate -w ./world` to check schemas, references, and values before committing
|
||||||
|
|
||||||
### New DB table
|
### New DB table
|
||||||
1. Add `CREATE TABLE IF NOT EXISTS` in `SqliteDb::open()`
|
1. Add `CREATE TABLE IF NOT EXISTS` in `SqliteDb::open()`
|
||||||
|
|||||||
@@ -218,6 +218,7 @@ Run through the checks below before every commit to ensure consistent feature co
|
|||||||
- [ ] Existing players can still log in when registration is closed
|
- [ ] Existing players can still log in when registration is closed
|
||||||
|
|
||||||
## MUD Tool - CLI
|
## MUD Tool - CLI
|
||||||
|
- [ ] `mudtool validate -w ./world` checks world data (schemas, references, values)
|
||||||
- [ ] `mudtool players list` shows all players
|
- [ ] `mudtool players list` shows all players
|
||||||
- [ ] `mudtool players show <name>` shows details
|
- [ ] `mudtool players show <name>` shows details
|
||||||
- [ ] `mudtool players set-admin <name> true` works
|
- [ ] `mudtool players set-admin <name> true` works
|
||||||
|
|||||||
Reference in New Issue
Block a user