Skip to content

RELEASE.md

Latest commit

 

History

History
162 lines (118 loc) · 3.39 KB

RELEASE.md

File metadata and controls

162 lines (118 loc) · 3.39 KB

Release checklist

Use this checklist before tagging a public release.

1. Verify working tree

git status --short

Expected: no unrelated changes.

2. Run local gate

uv sync --dev
uv run ruff format --check .
uv run ruff check .
uv run pytest tests/ -q
python -m compileall continuity tests scripts
./scripts/demo-retrieval.sh --quiet
python scripts/demo-small-model-context.py
./scripts/smoke-test.sh
uv build

3. Verify GitHub Actions CI

The repository includes .github/workflows/ci.yml, which runs the same release gate on Python 3.11 and 3.12 for pushes, pull requests, and manual dispatches.

Before making a public release, confirm the workflow has one green run on the default branch. After the first green run, configure branch protection to require CI before merging or tagging public release work.

4. Inspect package contents

python -m zipfile -l dist/*.whl | sort

Confirm these files are present:

continuity/plugin.yaml
continuity/py.typed
continuity/__init__.py
continuity/retrieval.py
continuity/store.py

5. Run isolated install smoke

The repository smoke test creates a temporary HERMES_HOME, installs the plugin, initializes it, exercises add/search/prefetch/delete, verifies memory mirroring and skill links, and checks wheel metadata when uv is available:

./scripts/smoke-test.sh

Expected output ends with:

smoke test ok

6. Review docs

Confirm these are current:

  • README.md
  • CHANGELOG.md
  • docs/INSTALL.md
  • docs/ARCHITECTURE.md
  • docs/REPO_MAP.md
  • docs/CONFIGURATION.md
  • docs/TUNING.md
  • docs/DEMO.md
  • docs/OPERATIONS.md
  • docs/PRIVACY.md
  • docs/CORPUS_INGESTION.md
  • docs/TROUBLESHOOTING.md
  • docs/SPEC.md
  • CONTRIBUTING.md
  • SECURITY.md

Confirm helper scripts are documented and safe:

  • scripts/install.sh
  • scripts/uninstall.sh

7. Bump version if needed

Update version in:

pyproject.toml
continuity/plugin.yaml
CHANGELOG.md

Initial alpha target:

0.1.0

8. Clean build artifacts

rm -rf dist build *.egg-info
uv build

Do not commit build artifacts.

9. Prepare GitHub repository

Before making the repo public, confirm:

  • repository description is set;
  • topics include hermes-agent, memory, sqlite, rag, and llm-agent;
  • Issues are enabled;
  • Actions are enabled;
  • default branch is main;
  • branch protection requires CI after the first green run;
  • no local runtime DBs, caches, secrets, .venv, or dist/ artifacts are tracked.

10. Tag release

Only push after deciding the GitHub remote and repository are correct.

git tag v0.1.0
git push origin main --tags

11. GitHub release notes

Suggested draft:

## Summary

Initial alpha release of Hermes Continuity Memory: a local-first structured memory provider for Hermes Agent.

## Features

- SQLite/FTS continuity store
- budgeted prefetch
- inspection/debug tools
- session marker extraction
- project capsules
- optional vector retrieval and reranking
- association graph for implicit context rescue
- built-in memory mirroring
- skill links
- stale-memory lifecycle
- review-first corpus ingestion with explicit import

## Limitations
- corpus ingestion is offline/review-first; no automatic background indexing
- no broad LLM summarization yet
- no multi-user ACLs
- retrieval quality is intentionally conservative and still tuning-sensitive