Skip to content

fix: gitignore mutable zallet configs to prevent git pull conflicts - #31

Merged
alchemydc merged 1 commit into
mainfrom
fix/gitignore-mutable-configs
May 30, 2026
Merged

fix: gitignore mutable zallet configs to prevent git pull conflicts#31
alchemydc merged 1 commit into
mainfrom
fix/gitignore-mutable-configs

Conversation

@gustavovalverde

Copy link
Copy Markdown
Member

Summary

  • Ship .default templates (tracked) for zallet configs, gitignore the live copies
  • regtest-init.sh auto-seeds from .default before modifying
  • README Quick Start includes cp -n to seed on first run

Problem

Following the README produces dirty tracked files:

  • config/zallet.toml — user edits network for testnet
  • config/regtest/zallet.tomlregtest-init.sh injects pwhash

These cause conflicts on git pull.

Verified

Both mainnet and regtest paths tested end-to-end:

  • Configs seed correctly from .default
  • Compose validates and starts
  • git diff shows zero tracked changes after setup

Users following the README modify config/zallet.toml (network setting)
and regtest-init.sh modifies config/regtest/zallet.toml (pwhash).
These tracked files caused conflicts on git pull.

- Ship .default templates (tracked) alongside gitignored live copies
- regtest-init.sh and CI seed from .default automatically
- zaino configs stay tracked (never modified by users/scripts)
@alchemydc
alchemydc self-requested a review May 30, 2026 18:41

@alchemydc alchemydc left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM. Standard "tracked template + gitignored live copy" pattern, cleanly applied across .gitignore, CI, the regtest init script, and the README. Compose mounts, CI sequencing, and seed_configs() placement all check out.

Three small notes, none blocking:

  1. The migration itself is a git pull conflict for existing devs with dirty configs
  2. README Quick Start only seeds the mainnet config; regtest users are covered via regtest-init.sh's new seed_configs().
  3. seed_configs() hardcodes the file list — fine for now, just prone to drift

@alchemydc
alchemydc merged commit 5a8f28e into main May 30, 2026
3 checks passed
@alchemydc
alchemydc deleted the fix/gitignore-mutable-configs branch May 30, 2026 18:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants