Skip to content

fix: remove splunk-cim-models references from documentation - #965

Merged
mkolasinski-splunk merged 4 commits into
mainfrom
fix/remove-splunk-cim-model-references
Sep 2, 2026
Merged

fix: remove splunk-cim-models references from documentation#965
mkolasinski-splunk merged 4 commits into
mainfrom
fix/remove-splunk-cim-model-references

Conversation

@mkolasinski-splunk

@mkolasinski-splunk mkolasinski-splunk commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

splunk-cim-models remains private package. Recently it was observed, that a package with same name was published on public PyPI - as a follow up this PR is adjusting all references across documentation to highlight that public splunk-cim-models is not supposed to be used with PSA.

@mkolasinski-splunk
mkolasinski-splunk requested a review from a team as a code owner September 2, 2026 10:02
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 2, 2026

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review Completed 2026-09-02T10:03:58.255429Z 03044a1 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 03044a1211

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/index.md Outdated
Comment on lines 25 to 28
To run **CIM compatibility tests** you also need the CIM data models package:

```console
pip3 install splunk-cim-models
```

`splunk-cim-models` is versioned independently of `pytest-splunk-addon` so that CIM
definitions can be updated without a full PSA release. See the

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Remove the dangling CIM installation paragraph

After deleting the package name and command, the installation section still says that CIM tests need “the CIM data models package” without identifying how to obtain it, and the following paragraph now begins mid-sentence with “definitions can be updated.” This leaves the primary setup instructions incomplete and grammatically broken; either remove this entire block or retain the package name and installation guidance.

Useful? React with 👍 / 👎.

@mkolasinski-splunk mkolasinski-splunk changed the title chore: remove splunk-cim-models references from documentation fix: remove splunk-cim-models references from documentation Sep 2, 2026
mbruzda-splunk
mbruzda-splunk previously approved these changes Sep 2, 2026
@mkolasinski-splunk
mkolasinski-splunk merged commit 07e99c9 into main Sep 2, 2026
8 of 9 checks passed
@mkolasinski-splunk
mkolasinski-splunk deleted the fix/remove-splunk-cim-model-references branch September 2, 2026 11:12
@github-actions github-actions Bot locked and limited conversation to collaborators Sep 2, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants