Skip to content

fix(coverage): correct the run_profile usage text, and use the app_configs path in deploy and standalone_ha - #5797

Merged
springfall2008 merged 4 commits into
springfall2008:mainfrom
gcoan:fix-run-profile-usage
Oct 28, 2026
Merged

springfall2008 merged 4 commits into
springfall2008:mainfrom
gcoan:fix-run-profile-usage

Conversation

@gcoan

@gcoan gcoan commented Oct 27, 2026

Copy link
Copy Markdown
Collaborator

Follow-up to the development guide review #5763, which noted two script defects.

Changes

  • coverage/run_profile: the usage text advertised a --time option, but profile_debug.py doesn't have one and rejects it (error: unrecognized arguments: --time). The usage text and example now use the correct --sort time.
  • coverage/deploy and coverage/standalone_ha: these hard-coded /Volumes/addon_configs/6adb4f0d_predbat, while standalone already prefers the new app_configs folder name and falls back to addon_configs. They now use the same check, so all three scripts behave the same.
  • docs/developing.md: remove above two documentation caveats, adds git fetch --prune to the "after your pull request is merged" steps. The guide already describes the app_configs-first behaviour for all three scripts, which this PR makes true.

Testing

Ran pre_commit, all passed
bash -n deploy, bash -n standalone_ha : both issued no errors
./run_profile : run with no parameters to confirm usage instructions
./run_profile --sort calls cases/predbat_debug_agile1.yaml : to confirm new parameter passed through and works OK

@github-actions github-actions Bot added the BOT_REVIEW Trigger an autotriage label Oct 27, 2026

@springfall2008 springfall2008 left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Automated comment from the triage bot.

Reviewed 4507589: the two script defects flagged in the #5763 review are fixed correctly. Verified run_profile's new usage text against profile_debug.py's argparse (-s/--sort with choices cumulative, time, calls, ncalls; -n/--top; -v/--view), and probed all four sort keys against live pstats on Python 3.12 — all accepted. Verified the new app_configs-first check in deploy and standalone_ha matches coverage/standalone's block verbatim, and that docs/developing.md now agrees (lines 191-196, 846), with no stale --time or addon_configs-only references left. The new git fetch --prune paragraph (and git push origin --delete) is consistent with the guide's own remote convention (fork = origin, step 11), and origin/main still has the old behaviour, so nothing here is superseded. One remaining gap, inline.

1 finding: 1 inline, 0 in the body.

Comment thread coverage/deploy Outdated
@springfall2008 springfall2008 removed the BOT_REVIEW Trigger an autotriage label Oct 27, 2026
@gcoan gcoan added the BOT_REVIEW Trigger an autotriage label Oct 27, 2026

@springfall2008 springfall2008 left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Automated comment from the triage bot.

Re-reviewed at head 8972bcf. No findings: the new commit resolves the previous review's one finding — the git_version.txt echo in coverage/deploy now runs after the app_configs/addon_configs selection and writes ${predbat_dir}/git_version.txt (coverage/deploy:15), which is where predbat.py:48 reads the marker via read_deploy_git_version(os.path.dirname(__file__)) (apps/predbat/download.py:148), so the dev-deploy version display stays current on the new folder name. The echo now fails the same way as the cp lines below it if the target directory is missing, which matches coverage/standalone's copy step.

Checked: the if/fi blocks in coverage/deploy and coverage/standalone_ha match coverage/standalone's verbatim; docs/developing.md now describes all three scripts as app_configs-first, which the diff makes true; the run_profile usage/--sort text matches profile_debug.py's argparse choices; the git fetch --prune / git push origin --delete paragraph is correct for the guide's fork=origin convention. Nothing to address.

@springfall2008 springfall2008 removed the BOT_REVIEW Trigger an autotriage label Oct 27, 2026
@springfall2008
springfall2008 merged commit e68bc54 into springfall2008:main Oct 28, 2026
2 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.

2 participants