Skip to content

Commit d3364c0

Browse files
committed
docs: document enable_discord_role_updates in Discord testing flow
1 parent 196b0e8 commit d3364c0

1 file changed

Lines changed: 7 additions & 2 deletions

File tree

docs/TESTING_DISCORD.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,18 @@ This guide explains how to safely validate Gitcord role automation in a Discord
44

55
## Recommended Test Sequence
66

7-
1. Keep `runtime.mode: "dry-run"` and `discord.permissions.write: false`.
7+
1. **Dry-run phase (no Discord role mutations):** In your config, set:
8+
- `runtime.mode: "dry-run"`
9+
- `runtime.enable_discord_role_updates: false`
10+
- `discord.permissions.write: false`
11+
With `enable_discord_role_updates: false`, `run-once` will not apply Discord role add/remove even if mode or permissions were mis-set.
812
2. Run a sync:
913
- `./.venv/bin/python -m ghdcbot.cli --config config/my-org-config.yaml run-once`
1014
3. Review the generated report at `<data_dir>/reports/audit.md`.
1115
4. Verify planned role changes and identity mappings are correct.
12-
5. Enable live updates only after review:
16+
5. **Live phase (apply role updates):** Only after review, set:
1317
- `runtime.mode: "active"`
18+
- `runtime.enable_discord_role_updates: true`
1419
- `discord.permissions.write: true`
1520
6. Run `run-once` again and confirm expected role changes in Discord.
1621

0 commit comments

Comments
 (0)