Skip to content

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

Open
etserend wants to merge 3 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 3 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>
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.

2 participants