Skip to content

fix(readme): document current settings, heartbeat behavior and CI - #16

Merged
AnnatarHe merged 1 commit into
mainfrom
fix/update-readme
Oct 9, 2026
Merged

AnnatarHe merged 1 commit into
mainfrom
fix/update-readme

Conversation

@AnnatarHe

@AnnatarHe AnnatarHe commented Oct 9, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

  • Manual install: GitHub releases have no ZIP attached, so point to the Marketplace versions page or a source build
  • Supported IDEs: 2024.1 through 2025.3 (builds 241–253.*, from gradle.properties), plus RustRover and DataSpell
  • Settings: defaults come from codeTracking.enabled / socketPath in the ShellTime config, changes apply immediately, and they reset on restart (no persisted state)
  • How It Works: restored-tab edits, per-project attribution, save/dedup rules, flush on project/IDE close, heartbeat contents, excluded paths relative to project root
  • New CLI Update Check and CI sections; development notes for JDK 17+, koverHtmlReport, verifyPlugin
  • Privacy: the update check makes one request to apiEndpoint
  • The Marketplace <!-- Plugin description --> block is unchanged

Test plan

  • Claims checked against gradle.properties, plugin.xml, Kotlin sources, workflows, and the CLI daemon

🤖 Generated with Claude Code


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.

Describe how settings derive from the ShellTime config, the heartbeat
attribution and flush-on-close fixes, the CLI update check, the exact
supported build range and the CI workflows. Point manual installs at
the Marketplace since GitHub releases carry no ZIP, and correct the
privacy note about the version check.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@AnnatarHe
AnnatarHe merged commit 17dc626 into main Oct 9, 2026
@AnnatarHe
AnnatarHe deleted the fix/update-readme branch October 9, 2026 11:20
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@claude

claude Bot commented Oct 9, 2026

Copy link
Copy Markdown

Review: README-only change, looks good.

I spot-checked the verifiable claims against the repo. pluginSinceBuild=241 and pluginUntilBuild=253.* match gradle.properties. docs/PUBLISHING.md exists. All four workflow files named in the CI section exist. The version/ package is in the project structure.

I didn't re-verify the behavioral claims (restored tabs, 2s flush wait, debugging category, excluded paths, update-check conditions). They match the PR's stated source checks.

Suggestions, none blocking:

  • The settings section says changes are in-memory only and reset on restart. That is surprising for a Settings panel, so you could track it as a follow-up issue and link it from the README, so the note can be dropped once settings persist.
  • The CI bullet that says the Claude workflows "review pull requests" will go stale easily. You could drop the specifics.
  • "Hover over it for the number of pending heartbeats" is useful. Check that the tooltip text stays in sync with the widget code.
  • The commit scope readme and the Conventional Commits title follow CLAUDE.md.

No code or tests are touched, so there are no performance, security or coverage concerns. The privacy note about the update-check request is a good addition.

🤖 Generated with Claude Code

@codecov

codecov Bot commented Oct 9, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

❌ Your project status has failed because the head coverage (14.21%) is below the target coverage (60.00%). You can increase the head coverage or adjust the target coverage.

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #16   +/-   ##
=======================================
  Coverage   14.21%   14.21%           
=======================================
  Files          20       20           
  Lines         802      802           
  Branches      184      184           
=======================================
  Hits          114      114           
  Misses        669      669           
  Partials       19       19           

Continue to review full report in Codecov by Harness.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ed0656a...25c6317. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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