Skip to content

fix(config): rename on-disk config file to splunk-ao-config.json (HYBIM-918) - #190

Open
etserend wants to merge 6 commits into
mainfrom
fix/HYBIM-918-rename-config-file
Open

fix(config): rename on-disk config file to splunk-ao-config.json (HYBIM-918)#190
etserend wants to merge 6 commits into
mainfrom
fix/HYBIM-918-rename-config-file

Conversation

@etserend

Copy link
Copy Markdown
Contributor

Summary

  • Renames SplunkAOConfig.config_filename from galileo-python-config.jsonsplunk-ao-config.json (src/splunk_ao/config.py:74)
  • Updates migration tool README: removes config filename from the "unchanged" list, adds new §5.3 with old→new table, adds checklist item in §9
  • Adds breaking change entry to CHANGELOG.md

Breaking Change

Users with saved credentials at ~/.galileo/galileo-python-config.json must either rename the file to ~/.galileo/splunk-ao-config.json or delete it and re-authenticate.

Test plan

  • grep confirms no tests reference the old filename — no test changes needed
  • 1902 tests passed locally (poetry run pytest); skipped tests are pre-existing optional-dep issues unrelated to this change

Jira: HYBIM-918

🤖 Generated with Claude Code

@etserend
etserend force-pushed the fix/HYBIM-918-rename-config-file branch from 204b656 to 2c0b6ca Compare July 30, 2026 21:33

@fercor-cisco fercor-cisco left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 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 to splunk-ao-config.json. Consider a separate ticket to evaluate renaming the directory for brand consistency, if desired.

fercor-cisco
fercor-cisco previously approved these changes Jul 31, 2026
@fercor-cisco

Copy link
Copy Markdown
Collaborator

Follow-up ticket created: https://splunk.atlassian.net/browse/HYBIM-952

etserend and others added 2 commits July 31, 2026 15:33
…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>
@etserend
etserend force-pushed the fix/HYBIM-918-rename-config-file branch from 2c0b6ca to e59ad46 Compare July 31, 2026 20:33
@fercor-cisco

Copy link
Copy Markdown
Collaborator

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:

```

  • `SplunkAOLogger.flush()` and `async_flush()` now return `None` and only drain
    completed spans already queued for OTLP export. They no longer conclude open
    spans or return uploaded proprietary trace objects.
    ```

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

  • Config file renamed (HYBIM-918): The on-disk credentials file written to
    `~/.galileo/` has been renamed from `galileo-python-config.json` to
    `splunk-ao-config.json`. ...
    ```

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 fercor-cisco left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 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).

@fercor-cisco

Copy link
Copy Markdown
Collaborator

Replying to #190 (comment)

This appears to be resolved in a later commit. The current CHANGELOG.md diff adds only the config-rename bullet under ### Breaking Changes; the flush()/async_flush() entry you flagged is no longer in that section. The reworded flush behavior now lives under ### Changed ("flush() and async_flush() now drain completed spans without concluding an active operation"), which is unrelated to this PR's hunk. No out-of-scope re-introduction remains.

….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>
@github-actions

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@fercor-cisco

Copy link
Copy Markdown
Collaborator

I have read the CLA Document and I hereby sign the CLA

fercor-cisco and others added 2 commits August 3, 2026 10:49
Co-Authored-By: Claude <noreply@anthropic.com>

@fercor-cisco fercor-cisco left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 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.json if splunk-ao-config.json is 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.

Comment thread CHANGELOG.md
@fercor-cisco

Copy link
Copy Markdown
Collaborator

Replying to #190 (comment)

Confirmed resolved. The current CHANGELOG.md diff adds only the config-rename bullet under ### Breaking Changes; the flush()/async_flush() bullet you flagged is no longer re-introduced there — the reworded flush behavior now lives under ### Changed and is unrelated to this hunk.

@fercor-cisco
fercor-cisco enabled auto-merge (squash) August 3, 2026 18:35
Comment thread CHANGELOG.md

### Breaking Changes

- **Config file renamed**: The on-disk credentials file written to

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants