Skip to content

docs: add CLAUDE.md with versioning and release workflow#4

Merged
simons-plugins merged 1 commit into
mainfrom
docs/add-claude-md
Mar 26, 2026
Merged

docs: add CLAUDE.md with versioning and release workflow#4
simons-plugins merged 1 commit into
mainfrom
docs/add-claude-md

Conversation

@simons-plugins

@simons-plugins simons-plugins commented Mar 26, 2026

Copy link
Copy Markdown
Owner

Summary

  • Adds CLAUDE.md documenting the plugin, endpoints, and CI release process
  • Bumps version to 2026.0.4

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation

    • Added comprehensive plugin documentation covering REST API endpoints, query parameters, version management guidelines, and installation instructions.
  • Chores

    • Plugin version updated to 2026.0.4.

Documents the plugin, its endpoints, and the CI release process.
Bumps version to 2026.0.4.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Mar 26, 2026

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

A new documentation file for the Logs Over Reflector Indigo plugin is added, detailing its endpoints, query parameters, and setup instructions. The plugin version is simultaneously bumped from 2026.0.3 to 2026.0.4 in the manifest.

Changes

Cohort / File(s) Summary
Documentation
CLAUDE.md
New documentation file describing the Logs Over Reflector plugin, including REST endpoints (log, sources, history, dates), supported query parameters, directory structure, and installation/testing instructions.
Plugin Metadata
LogsOverReflector.indigoPlugin/Contents/Info.plist
Version bump: PluginVersion and CFBundleVersion updated from 2026.0.3 to 2026.0.4.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐰 A plugin grows with docs so clear,
Version bumped without a fear,
Four-zero-four now marks the way,
Reflector logs see light of day! 📝✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main changes: adding CLAUDE.md documentation and addressing the version bump workflow.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/add-claude-md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai 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.

Actionable comments posted: 1

🧹 Nitpick comments (2)
CLAUDE.md (2)

49-57: Add a language identifier to the fenced block.

Line 49 starts a fenced code block without a language, which triggers markdownlint MD040.

Proposed doc fix
-```
+```text
 LogsOverReflector.indigoPlugin/
 └── Contents/
     ├── Info.plist
     └── Server Plugin/
         ├── plugin.py          # HTTP handlers (log, sources, history, dates)
         ├── Actions.xml        # Action definitions for HTTP endpoints
         └── PluginConfig.xml   # Plugin preferences
</details>

<details>
<summary>🤖 Prompt for AI Agents</summary>

Verify each finding against the current code and only fix it if needed.

In @CLAUDE.md around lines 49 - 57, In CLAUDE.md update the fenced code block
that begins with to include a language identifier (e.g., change to
text) so the block becomes text ... ```; this satisfies markdownlint MD040
and keeps the directory listing rendered as plain text.


</details>

---

`63-63`: **Use a portable plugin path in the install example.**

Line 63 hardcodes a host-specific volume/name and Indigo version; this is brittle for other environments.



<details>
<summary>Proposed doc fix</summary>

```diff
-cp -r "LogsOverReflector.indigoPlugin" "/Volumes/Macintosh HD-1/Library/Application Support/Perceptive Automation/Indigo 2025.1/Plugins/"
+cp -r "LogsOverReflector.indigoPlugin" "/Library/Application Support/Perceptive Automation/Indigo <version>/Plugins/"
```
</details>

<details>
<summary>🤖 Prompt for AI Agents</summary>

```
Verify each finding against the current code and only fix it if needed.

In `@CLAUDE.md` at line 63, The install example currently uses a hardcoded
absolute path ("cp -r \"LogsOverReflector.indigoPlugin\" \"/Volumes/Macintosh
HD-1/Library/Application Support/Perceptive Automation/Indigo
2025.1/Plugins/\"") which is host- and version-specific; replace it with a
portable instruction that uses the user's home directory and a variable or
placeholder for Indigo version (e.g., reference HOME or ~ and an INDIGO_VERSION
placeholder) or describe how to target the user's Indigo Plugins folder
generically (e.g., "~/Library/Application Support/Perceptive
Automation/Indigo/<INDIGO_VERSION>/Plugins/") and mention using Finder/Indigo
preferences if the path is unknown so the example works across machines and
versions and still references the LogsOverReflector.indigoPlugin package name.
```

</details>

</blockquote></details>

</blockquote></details>

<details>
<summary>🤖 Prompt for all review comments with AI agents</summary>

Verify each finding against the current code and only fix it if needed.

Inline comments:
In @LogsOverReflector.indigoPlugin/Contents/Info.plist:

  • Line 6: The plugin version bump is invalid because the value "2026.0.4"
    already exists as a git tag; update both the PluginVersion entry and the
    CFBundleVersion entry in Info.plist (the values for PluginVersion and
    CFBundleVersion) to a new unused version (e.g., "2026.0.5") ensuring both fields
    match the same new version before committing.

Nitpick comments:
In @CLAUDE.md:

  • Around line 49-57: In CLAUDE.md update the fenced code block that begins with
    to include a language identifier (e.g., change to text) so the block becomes text ... ```; this satisfies markdownlint MD040 and keeps the
    directory listing rendered as plain text.
  • Line 63: The install example currently uses a hardcoded absolute path ("cp -r
    "LogsOverReflector.indigoPlugin" "/Volumes/Macintosh HD-1/Library/Application
    Support/Perceptive Automation/Indigo 2025.1/Plugins/"") which is host- and
    version-specific; replace it with a portable instruction that uses the user's
    home directory and a variable or placeholder for Indigo version (e.g., reference
    HOME or ~ and an INDIGO_VERSION placeholder) or describe how to target the
    user's Indigo Plugins folder generically (e.g., "~/Library/Application
    Support/Perceptive Automation/Indigo/<INDIGO_VERSION>/Plugins/") and mention
    using Finder/Indigo preferences if the path is unknown so the example works
    across machines and versions and still references the
    LogsOverReflector.indigoPlugin package name.

</details>

<details>
<summary>🪄 Autofix (Beta)</summary>

Fix all unresolved CodeRabbit comments on this PR:

- [ ] <!-- {"checkboxId": "4b0d0e0a-96d7-4f10-b296-3a18ea78f0b9"} --> Push a commit to this branch (recommended)
- [ ] <!-- {"checkboxId": "ff5b1114-7d8c-49e6-8ac1-43f82af23a33"} --> Create a new PR with the fixes

</details>

---

<details>
<summary>ℹ️ Review info</summary>

<details>
<summary>⚙️ Run configuration</summary>

**Configuration used**: defaults

**Review profile**: CHILL

**Plan**: Pro

**Run ID**: `575df3e9-d066-406e-a5f5-541ea7484613`

</details>

<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between 3d6e14800b713fd0c1e018a30e78aead061c6dcd and 1d021dd2d9b52c2e2e1561c86e155c0c263bbc62.

</details>

<details>
<summary>📒 Files selected for processing (2)</summary>

* `CLAUDE.md`
* `LogsOverReflector.indigoPlugin/Contents/Info.plist`

</details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

<dict>
<key>PluginVersion</key>
<string>2026.0.3</string>
<string>2026.0.4</string>

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

Version bump is still invalid and currently blocks release.

CI is failing because 2026.0.4 already exists as a git tag. Update both Line 6 (PluginVersion) and Line 14 (CFBundleVersion) to a new unused version (for example, 2026.0.5).

Proposed fix
-    <string>2026.0.4</string>
+    <string>2026.0.5</string>
...
-    <string>2026.0.4</string>
+    <string>2026.0.5</string>

Also applies to: 14-14

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@LogsOverReflector.indigoPlugin/Contents/Info.plist` at line 6, The plugin
version bump is invalid because the value "2026.0.4" already exists as a git
tag; update both the PluginVersion entry and the CFBundleVersion entry in
Info.plist (the <string> values for PluginVersion and CFBundleVersion) to a new
unused version (e.g., "2026.0.5") ensuring both fields match the same new
version before committing.

@simons-plugins simons-plugins merged commit be6a1cb into main Mar 26, 2026
3 checks passed
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.

1 participant