test: add version test module
Metadata
Current evaluation
Add version test module for starbase docs, mocking a planned conf.py function. Inactive for 52 days with 10 unresolved review comments.
Suggested action: close stale
Reason: Related PRs (#588, #520) have addressed the underlying issue (#532) about version display in docs. The author noted the approach might need reconsideration, and the PR mocks a function that was never implemented, making the test less useful.
Impact:
30
Quick Win:
24.0
Staleness:
70
Complexity:
20
Confidence:
60
Issue body
The version attribute inside a craft (`craft.__version__`) is generated by Setuptools, so it's outside of the scope of the modules. The docs, however, rely on it for the version in the toolbar.
This PR adds a standalone test module for the version string, and checks against common values. It mocks a function that I plan to add to `conf.py`, but isn't implemented yet.
This is a first step toward fixing #532.
## Concerns
There's nothing to guarantee `conf.py` will have this function. We're creating a value in the docs, then mocking the logic in an unrelated test, so there's no coupling.
I think it would be more ideal if each craft could provide something like `craft.__version_major_minor__`, so the logic would reside in the app itself, not the docs. Is there a simple place to put that?
---
- [x] I've followed the [contribution guidelines](https://github.com/canonical/starbase/blob/main/CONTRIBUTING.md).
- [x] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/).
- [x] I've successfully run `make lint && make test`.
- [ ] I've added or updated any relevant documentation.
- [ ] In documents I changed, I [added a meta description](https://canonical-starflow.readthedocs-hosted.com/how-to/add-a-page-meta-description/) if one was missing.
- [ ] I've updated the relevant release notes.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen3.6-35b-a3b-mtp-q6 |
Impact:
30
Quick Win:
24.0
Staleness:
70
Complexity:
20
Confidence:
60
|
close stale | Add version test module for starbase docs, mocking a planned conf.py function. Inactive for 52 days with 10 unresolved review comments. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
15
Complexity:
12
Confidence:
85
|
needs review | Adds a standalone test module for craft.__version__ and mocks a conf.py function. Currently pending review with 10 unresolved comments. Author recently noted the test might belong in an existing integration test. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
15
Complexity:
20
Confidence:
80
|
keep open | Adds a standalone test module for the craft version string and mocks a future conf.py function. The author is reconsidering whether to merge this into an existing integration test. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
15
Complexity:
20
Confidence:
85
|
needs review | Adds a standalone test module for craft.__version__ and mocks a conf.py function. Author suggests consolidating with an existing integration test. Currently awaiting maintainer feedback. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/starbase#588
(confidence 70%)
PR #588 merged a fix for the same version display issue (#532)
Related issues
No related issues found above the similarity threshold.