Release Process

Release Process

This page documents the recommended release process for maintainers.

Versioning

Use semantic version-like tags:

v0.6.5
v0.7.0
v0.7.5
v0.8.0

Suggested meaning:

• patch: bug fixes, documentation, compatibility improvements
• minor: new features that preserve default compatibility
• major or v1.0.0: stable API boundary

Pre-Release Checklist

1. Update version metadata.
2. Update README news.
3. Update Wiki pages if public behavior changed.
4. Run focused tests locally.
5. Confirm CI passes on main or the release PR.
6. Review examples for stale model names, URLs, and environment variables.
7. Draft release notes from merged PRs and issues.

Local Checks

python -m compileall -q LightAgent tests/test_v065_core.py tests/test_v070_tracing.py tests/test_memory_policy.py tests/test_lightflow.py
PYTHONPATH=. python -m pytest -q tests/test_v065_core.py tests/test_v070_tracing.py tests/test_memory_policy.py tests/test_lightflow.py

GitHub Release Notes

A good release note includes:

• highlights
• compatibility notes
• migration notes
• testing summary
• links to related PRs and issues

After Release

• Verify the GitHub release page.
• Verify package publishing if PyPI is part of the release.
• Announce the release with links to the README, Wiki, and examples.
• Open follow-up issues for known limitations or deferred work.