Skip to content

fix: align removed-command and HAP/MAP messaging with holoscan version convention#185

Merged
wyli merged 4 commits into
mainfrom
fix/update-v1-comments-to-version
Jun 9, 2026
Merged

fix: align removed-command and HAP/MAP messaging with holoscan version convention#185
wyli merged 4 commits into
mainfrom
fix/update-v1-comments-to-version

Conversation

@wyli

@wyli wyli commented Jun 5, 2026

Copy link
Copy Markdown
Collaborator

Summary

Replaces the internal "v1" codename with the public release version ("holoscan v4.3.0") everywhere it appears in user-facing messaging. holoscan-cli now versions in lockstep with the Holoscan SDK, so "v1" is meaningless to users.

This unifies the split work previously in #184 and #185 into a single PR. (#184 is closed as superseded.)

Changes

  • src/holoscan_cli/__main__.py — removed-command error line + footer strings, and the explanatory comments
  • README.mdHOLOHUB_* env-var deprecation note and the HAP/MAP packaging deprecation section
  • tests/unit/test_main.py — assertions now pin the new "since holoscan v4.3.0" wording

Before (holoscan nics):

Error: 'holoscan nics' was removed in holoscan-cli v1 — the HAP NIC diagnostic command is no longer shipped.
Removed HAP/MAP commands are out of scope for holoscan-cli v1. Pin holoscan-cli<=4.2.0 if you still need that legacy command surface.

After:

Error: 'holoscan nics' was removed since holoscan v4.3.0 — the HAP NIC diagnostic command is no longer shipped.
Removed HAP/MAP commands are not available since holoscan v4.3.0. Pin holoscan-cli<=4.2.0 if you still need that legacy command surface.

Test plan

  • pytest tests/ — 389 passed locally
  • pre-commit run --files ... — all hooks pass (ruff, black, isort, codespell, markdownlint)
  • No remaining "v1" version references in tracked files (local-docs/ is gitignored and out of scope)

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation

    • Clarified deprecation: legacy HOLOHUB_* env vars are not honored since v4.3.0 — use HOLOSCAN_CLI_* instead.
    • Clarified HAP/MAP packaging deprecation and noted that holoscan nics and monai-deploy are intentionally not provided; expanded guidance and recommended pinning for legacy HAP/MAP users.
  • Bug Fixes

    • Improved removed-command error messages to include removal version (since v4.3.0) and explicit pinning guidance (holoscan-cli<=4.2.0 and holoscan<=4.2.0).

@coderabbitai

coderabbitai Bot commented Jun 5, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: f3ce0c6b-8498-499c-af75-b0131e9ad6fa

📥 Commits

Reviewing files that changed from the base of the PR and between d89242b and efb2007.

📒 Files selected for processing (1)
  • README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

Walkthrough

The PR updates user-facing documentation, CLI error messages, and tests to state that legacy HOLOHUB_* env vars are no longer honored and HAP/MAP packaging/commands were removed since holoscan v4.3.0, adding explicit pinning guidance (holoscan-cli<=4.2.0 and holoscan<=4.2.0) for legacy support.

Changes

v4.3.0 Breaking Change Messaging

Layer / File(s) Summary
Error messaging and validation for removed commands
src/holoscan_cli/__main__.py, tests/unit/test_main.py
REMOVED_COMMAND_FOOTER constant updated to reference holoscan v4.3.0 and explicit pin constraints; _exit_if_removed_command error string now reports removal “since holoscan v4.3.0”; tests updated to assert the new stderr messaging including the constraint string.
User documentation for environment variables and packaging deprecation
README.md
Docs updated to state legacy HOLOHUB_* env var spellings are no longer honored since v4.3.0; HAP/MAP packaging section clarified to note omitted holoscan nics/monai-deploy, describe holoscan package/run behavior after v4.3.0, and require pinning holoscan-cli<=4.2.0 and holoscan<=4.2.0 for legacy workflows.

🎯 3 (Moderate) | ⏱️ ~20 minutes

Suggested reviewers

  • tbirdso
🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: replacing internal 'v1' codename with public version 'holoscan v4.3.0' in user-facing messaging to align with holoscan-cli's versioning convention.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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


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

@github-actions

github-actions Bot commented Jun 5, 2026

Copy link
Copy Markdown

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

…n convention

holoscan-cli now versions in lockstep with the Holoscan SDK, so the
internal "v1" codename is meaningless to users. Replace it with the
public release version (holoscan v4.3.0) everywhere it appears in
user-facing messaging:

- src/holoscan_cli/__main__.py: removed-command error + footer strings
  and the explanatory comments
- README.md: HOLOHUB_* env-var deprecation note and the HAP/MAP
  packaging deprecation section
- tests/unit/test_main.py: pin the new "since holoscan v4.3.0" wording

Supersedes the split work in #184 and #185.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@wyli wyli force-pushed the fix/update-v1-comments-to-version branch from 106ba19 to b28f8bb Compare June 5, 2026 08:16
@wyli wyli changed the title fix: replace internal 'v1' codename with 'since holoscan v4.3.0' fix: align removed-command and HAP/MAP messaging with holoscan version convention Jun 5, 2026
@wyli wyli requested a review from tbirdso June 5, 2026 08:20
Comment thread README.md Outdated
Co-authored-by: Codex <noreply@openai.com>

@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

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Line 152: The long paragraph beginning "Application packaging (HAP/MAP) is no
longer part of this CLI..." in README.md exceeds markdownlint MD013; break it
into multiple shorter lines (or separate sentences into separate lines) so no
single line exceeds the 800-character limit, preserving original wording and
links (e.g., the holoscan CLI/package names and the issue `#164` link) and
ensuring Markdown still renders as one paragraph.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a80e739b-b3c4-47a7-be1d-aa96693fca61

📥 Commits

Reviewing files that changed from the base of the PR and between 7f4ffef and d89242b.

📒 Files selected for processing (3)
  • README.md
  • src/holoscan_cli/__main__.py
  • tests/unit/test_main.py

Comment thread README.md Outdated
@wyli wyli requested a review from MMelQin June 8, 2026 08:35

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

LGTM

@wyli wyli merged commit 0fbaec9 into main Jun 9, 2026
27 checks passed
@wyli wyli deleted the fix/update-v1-comments-to-version branch June 9, 2026 11:11
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