Repository navigation
Docs rag release checklist - #216
Conversation
sanjayankur31
left a comment
sanjayankur31
left a comment
There was a problem hiding this comment.
Looks good. We also need a few more steps I think:
- check documentation (api + user facing) is up to date
- run a security audit?
- update HuggingFace spaces for deployment test (everyone can do a few free huggingface spaces & delete them after testing)
- test with a few different models from a few providers (huggingface/opencode/anthropic/openai)
- do a full UX test for both web + tui (make sure all the dialogs/buttons etc. work as expected)
Any thing else? What else can users do that we havent tested/checked?
|
Hii, yes, those can go in. A few more:
there is no audit script, so I think pip-audit on the fresh install could be the security check. |
|
We can probably use AI agents to do a security audit too---I'm looking the evaluation/e2e testing framework too. Once we have that, we'll be able to run e2e tests more easily. |
sanjayankur31
left a comment
sanjayankur31
left a comment
There was a problem hiding this comment.
Looking very good. Once we have an automated E2E testing harness, it'll be come more complete too.
Other things to think about: the config/data storage---loading of chats + inspection pane and all that.
| A tag push uploads it to PyPI. The tag version is not compared with | ||
| `version` in `setup.cfg`, so those two have to be checked by hand. | ||
|
|
||
| Last released tags: `klea_utils-v0.5.0`, `klea_rag-v0.5.0`. |
There was a problem hiding this comment.
should this hard-code versions? we'll have to update this with each tag too. Maybe this should be a generic instruction to "check the last release"?
|
|
||
| ## Before the tag | ||
|
|
||
| - [ ] If `klea_utils` changed since `klea_utils-v0.5.0`, release it |
| for each package that is shipping. The tag pushed later has to | ||
| be that same number (`klea_rag-v0.6.0` for `version = 0.6.0`). | ||
| - [ ] Update `CHANGELOG.md`. Tagged releases share one heading for | ||
| `klea_utils` / `klea_rag`. |
There was a problem hiding this comment.
"Check changelog is up to date" is probably also required---can ask klea-agent to go through the git log and ensure changelog has all changes?
| git push git@github.com:NeuroML/klea.git klea_rag-vX.Y.Z | ||
| ``` | ||
|
|
||
| Stop after the tag push. Publishing a GitHub Release for the same tag |
There was a problem hiding this comment.
i dont think we do github releases, since we're in a monorepo with multiple packages, so we just do tags. each package follows its own versioning etc., so releases get a bit muddled..
|
Hii, updated. Versions are no longer hard-coded, changelog check + uv install are in, E2E section is a TODO stub, and the workflow has a TestPyPI comment. Parallel TUI envs against klea-serve go on the agent checklist. |
Description
devdocs/rag-release-checklist.mdwith the steps for aklea_utils/klea_ragrelease: version and changelog, TestPyPI smoke, then the tag.Related issue
Fixes #190
Checklist
developmentbranchAI use