diff --git a/README.md b/README.md index 6104f70..0d38610 100644 --- a/README.md +++ b/README.md @@ -97,6 +97,15 @@ The defaults work for local development. Notable variables in `src/infra/.env`: | `RESOLVER_CONFIG_PATH` | *(bundled `/app/config/resolver.yaml`)* | Path to the Splink resolver config YAML. Override to use a custom resolver config outside Docker. | | `DUCKDB_PATH` | *(resolver default)* | Path to the DuckDB database file. Leave unset to use the path defined in `resolver.yaml`. | +> **Schema or configuration changes:** If you have modified `src/config/resolver.yaml` or +> `src/config/rdf_mapping.yaml` and the DuckDB database has already been initialised, +> remove the data volume before restarting to avoid schema mismatch errors: +> ```bash +> docker volume rm ere-local_ere-data +> # or for a full clean slate: +> make infra-down-volumes +> ``` + ### 3. Start the stack ```bash @@ -108,6 +117,12 @@ Note: `make infra-up` creates a shared external network `ersys-local` used for c To remove it manually: `docker network rm ersys-local` ``` +> **Rebuilding with a clean cache:** If you have upgraded the source or made changes to the +> image and need to discard Docker layer cache, run: +> ```bash +> make infra-rebuild-clean +> ``` + | Service | URL / Port | |---------|-----------| | Redis | `localhost:6379` | @@ -355,5 +370,4 @@ Contributions are welcome. Please open an issue before submitting a pull request - Keep commits small and well-described - Branch naming: `feature//` (e.g. `feature/ERS1-124/conflict-detection`) -For active tasks and current work, edit [WORKING.md](WORKING.md). For development workflow and architecture guidelines, see [CLAUDE.md](.claude/CLAUDE.md). diff --git a/src/VERSION b/src/VERSION index e27c22b..b2d500d 100644 --- a/src/VERSION +++ b/src/VERSION @@ -1 +1 @@ -1.1.0-rc.2 +1.1.0-rc.3 diff --git a/src/infra/.env.example b/src/infra/.env.example index 1b9f044..ea0bb09 100644 --- a/src/infra/.env.example +++ b/src/infra/.env.example @@ -6,6 +6,10 @@ # When running inside the full ERSys stack, the parent project's .env covers these. # --- Redis --- +# When running the demo from the host machine (poetry run python demo/demo.py), +# the Docker service name 'ersys-redis' is not resolvable from the host. Set +# REDIS_HOST=localhost here before running the demo. The ERE container reads this +# file at startup, so restore the original value before restarting the stack. REDIS_HOST=ersys-redis REDIS_PORT=6379 REDIS_DB=0 diff --git a/src/pyproject.toml b/src/pyproject.toml index 3cdfde3..3c1e981 100644 --- a/src/pyproject.toml +++ b/src/pyproject.toml @@ -3,7 +3,7 @@ name = "ere-basic" version = "1.1.0" description = "A basic implementation of the Entity Resolution Engine (ERE)." authors = [ - {name = "Meaningfy",email = "hi@meaningfy.ws"} + {name = "Publications Office of the European Union"} ] readme = "../README.md" requires-python = ">=3.12,<3.15"