Release Process

This page documents the current release expectations for Kaya and the developer documentation.

Versioning

Kaya uses Git branches for development and Git tags for stable releases.

The default Docker image is:

ghcr.io/antybubbs/kaya:latest

Release tags should have matching container image tags so KAYA_IMAGE=ghcr.io/antybubbs/kaya:vX.Y.Z docker compose up -d works.

Developer documentation pages use the MDX version frontmatter field. The current docs use current, matching the currently documented Kaya release stream.

Current GitHub state

The Kaya repository is:

https://github.com/antybubbs/Kaya.git

Relevant remote branches checked:

• main
• dev0.23.0

Latest remote tag checked:

• v0.21.4

Release workflow

Before release:

1. Review changed application behaviour.
2. Update matching Developer Documentation pages.
3. Update installation, update and deployment docs if image, Compose or release behaviour changed.
4. Run available checks and tests.
5. Build and publish the Docker image.
6. Merge the release-ready branch.
7. Create a version tag.
8. Push the tag to GitHub.
9. Confirm install instructions work from the pushed tag and image.

Example tag flow:

git checkout main
git pull --ff-only
git tag v0.22.0
git push origin v0.22.0

Expected image tags for that release:

ghcr.io/antybubbs/kaya:v0.22.0
ghcr.io/antybubbs/kaya:latest

Branch workflow

Use branches for unreleased application work:

git checkout -b dev0.24.0
git push -u origin dev0.24.0

Kaya's GitHub Actions publish matching GHCR image tags for dev* branches. After the branch image build completes, branch installs can use the branch name as the image tag:

KAYA_IMAGE=ghcr.io/antybubbs/kaya:dev0.24.0 docker compose up -d

Documentation updates

Documentation should be updated with the code or behaviour that changes.

Use these routing rules:

• Route/model/settings changes: update the relevant module page.
• Schema changes: update Database.
• Auth/security/upload/secret changes: update Security.
• Agent/provider/API changes: update API & Integrations.
• Operational/deployment changes: update Deployment.
• Install, update or release changes: update Installing Kaya, Updating Kaya and this page.

Changelog process

No dedicated changelog process was identified in the inspected repositories. Until one exists, release notes should be derived from merged changes and documentation updates.