2026-10-22 15:03:56 +02:00
|
|
|
# Release process
|
|
|
|
|
|
|
|
|
|
### 1. Add changelog
|
|
|
|
|
|
2026-10-22 16:20:48 +02:00
|
|
|
Add an entry for the new version at the top of `docs/changelog.rst`.
|
|
|
|
|
|
2026-10-22 15:03:56 +02:00
|
|
|
### 2. Update version number
|
|
|
|
|
|
2026-10-22 16:20:48 +02:00
|
|
|
Both files must have the same version (it is shown to clients by `server.version`, in the banner and in the logs):
|
|
|
|
|
|
2026-10-22 15:03:56 +02:00
|
|
|
- `docs/conf.py`
|
2026-10-22 16:20:48 +02:00
|
|
|
- `src/electrumx/__init__.py`
|
2026-10-22 15:03:56 +02:00
|
|
|
|
2026-10-22 16:20:48 +02:00
|
|
|
### 3. Check
|
2026-10-22 15:03:56 +02:00
|
|
|
|
2026-10-22 16:20:48 +02:00
|
|
|
The CI on `main` (`.github/workflows/ci.yml`) must pass: tests, pycodestyle, docs build, and the Docker image with its
|
|
|
|
|
smoke test (`contrib/docker-smoke-test.sh`).
|
2026-10-22 15:03:56 +02:00
|
|
|
|
2026-10-22 16:20:48 +02:00
|
|
|
### 4. Deploy
|
2026-10-22 15:03:56 +02:00
|
|
|
|
2026-10-22 16:20:48 +02:00
|
|
|
On the server: `git pull && docker compose up -d --build` (see `DEPLOY.md`).
|
