fix(config): rename on-disk config file to splunk-ao-config.json (HYBIM-918) - #190
fix(config): rename on-disk config file to splunk-ao-config.json (HYBIM-918)#190etserend wants to merge 6 commits into
Conversation
204b656 to
2c0b6ca
Compare
fercor-cisco
left a comment
There was a problem hiding this comment.
🤖 This review was generated by the Astra agent (claude-opus-4-8). It may contain mistakes.
Verdict: approve — Correct, well-scoped rename matching the ticket; docs, changelog, and a regression test are all consistent with no stale references.
Follow-ups
Suggested follow-up work that could be tracked as Jira tickets:
src/splunk_ao/config.py:74-74: The config directory remains~/.galileo/(still using the old brand name) while only the filename is rebranded tosplunk-ao-config.json. Consider a separate ticket to evaluate renaming the directory for brand consistency, if desired.
|
Follow-up ticket created: https://splunk.atlassian.net/browse/HYBIM-952 |
…o-config.json (HYBIM-918) Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
…k-ao-config.json (HYBIM-918) Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2c0b6ca to
e59ad46
Compare
|
CHANGELOG.md contains a change unrelated to this PR. After the rebase onto current `main`, the `CHANGELOG.md` hunk re-adds the entire `### Breaking Changes` section — which includes a second bullet that is out of scope for HYBIM-918: ```
That `flush()`/`async_flush()` entry was deliberately removed from `main` in the release-refresh commit (`acc2d24`) — it no longer exists anywhere in `main`'s CHANGELOG. Re-introducing it here would silently revert that intentional edit. This PR's CHANGELOG change should contain only the config-file rename entry: ``` Breaking Changes
Could you drop the `flush()` bullet from the CHANGELOG hunk? The other three files (`config.py`, `test_config.py`, migration-tool `README.md`) look clean. |
…GELOG hunk Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
fercor-cisco
left a comment
There was a problem hiding this comment.
🤖 This review was generated by the Astra agent (claude-opus-4-8). It may contain mistakes.
Verdict: approve — Small, correctly-scoped rename matching HYBIM-918; code, docs, and CHANGELOG are consistent and the earlier CHANGELOG review concern is resolved.
Follow-ups
Suggested follow-up work that could be tracked as Jira tickets:
tests/test_config.py:346-347: test_config_filename_default asserts the pydantic field default only. Consider a lightweight test that verifies runtime behavior — e.g. that an instantiated SplunkAOConfig resolves its on-disk config path to splunk-ao-config.json — so the test guards actual usage rather than just the declared default.src/splunk_ao/config.py:74-74: The credentials file is renamed but still written under ~/.galileo/. The directory still carries the old brand; tracked separately in HYBIM-952 (directory rebrand).
This appears to be resolved in a later commit. The current |
….json (HYBIM-918) Complements test_config_filename_default (which only checks the declared pydantic field default) by exercising the runtime config_file property that galileo-core reads from and writes to on disk. Co-Authored-By: Claude <noreply@anthropic.com>
|
All contributors have signed the CLA ✍️ ✅ |
|
I have read the CLA Document and I hereby sign the CLA |
…config-file # Conflicts: # CHANGELOG.md
Co-Authored-By: Claude <noreply@anthropic.com>
fercor-cisco
left a comment
There was a problem hiding this comment.
🤖 This review was generated by the Astra agent (claude-opus-4-8). It may contain mistakes.
Verdict: approve — Clean, well-documented, single-purpose rename that matches the ticket; consistent across code, tests, and docs, with adequate test coverage.
Follow-ups
Suggested follow-up work that could be tracked as Jira tickets:
tests/test_config.py:82-113: This PR reflows several unrelated assertion messages (multi-line parenthesized strings collapsed to single lines) that are unrelated to the config rename. Harmless (likely a formatter pass), but it adds noise to a focused PR; consider isolating pure-formatting changes in a separate commit/PR in the future.src/splunk_ao/config.py:74-74: Consider whether a one-time migration shim (read~/.galileo/galileo-python-config.jsonifsplunk-ao-config.jsonis absent, then write the new name) would smooth the upgrade path. Currently existing users silently lose saved credentials and must re-authenticate. This is documented as a breaking change and acceptable for the rebrand, but a graceful fallback could reduce user friction if desired.
Confirmed resolved. The current |
|
|
||
| ### Breaking Changes | ||
|
|
||
| - **Config file renamed**: The on-disk credentials file written to |
There was a problem hiding this comment.
Since we are resetting the CHANGELOG I think this should not be categorized as breaking changes
| + scorer = SplunkAOEvaluators.completeness | ||
| ``` | ||
|
|
||
| ### 5.3 On-Disk Config File Renamed |
There was a problem hiding this comment.
Since splunk-ao-python is a separate release, this not really a rename. Also should the dir be changed to ~/.splunk_ao, currently the sdk home dir is inherited from galileo-core
Summary
SplunkAOConfig.config_filenamefromgalileo-python-config.json→splunk-ao-config.json(src/splunk_ao/config.py:74)CHANGELOG.mdBreaking Change
Users with saved credentials at
~/.galileo/galileo-python-config.jsonmust either rename the file to~/.galileo/splunk-ao-config.jsonor delete it and re-authenticate.Test plan
grepconfirms no tests reference the old filename — no test changes neededpoetry run pytest); skipped tests are pre-existing optional-dep issues unrelated to this changeJira: HYBIM-918
🤖 Generated with Claude Code