Skip to content

Add holoscan-cli tool-runner alias#190

Merged
wyli merged 1 commit into
mainfrom
codex-tool-runner-alias
Jun 15, 2026
Merged

Add holoscan-cli tool-runner alias#190
wyli merged 1 commit into
mainfrom
codex-tool-runner-alias

Conversation

@wyli

@wyli wyli commented Jun 12, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • add holoscan-cli as a console-script alias for package-name based tool runners
  • document transient uvx and pipx run usage while keeping holoscan as the primary command
  • extend installed-wheel and CI smoke tests for the alias and local wheel tool-runner execution

Testing

  • python -m pytest -q -o addopts='' tests/unit
  • python -m build --wheel --outdir /tmp/holoscan-cli-build.3YvykB
  • .github/scripts/smoke_test.sh /tmp/holoscan-cli-smoke.djy10k/bin
  • .github/scripts/tool_runner_smoke.sh /tmp/holoscan-cli-build.3YvykB

AI-assisted: Created with Codex/GPT at the user's request.

Summary by CodeRabbit

  • New Features

    • Added holoscan-cli entrypoint as a tool-runner compatible alias for transient command execution via uvx and pipx run.
  • Documentation

    • Updated README with guidance on using holoscan-cli with external tool runners for non-installed environments.
  • Tests

    • Expanded test coverage to validate both holoscan and holoscan-cli entrypoints.

Add a holoscan-cli console script alias so package-name based tool runners can execute the CLI directly while keeping holoscan as the canonical command. Extend wheel smoke coverage and CI tool-runner checks for uvx and pipx run.

Co-authored-by: Codex <noreply@openai.com>
@github-actions

Copy link
Copy Markdown

Dependency Review

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

Scanned Files

None

@wyli wyli requested review from jcfr and tbirdso June 12, 2026 11:43
@coderabbitai

coderabbitai Bot commented Jun 12, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

This PR extends holoscan-cli packaging to support tool-runner execution (uvx/pipx) by adding a holoscan-cli console script entrypoint, validating it through unit and smoke tests, integrating it into CI/CD workflows, and documenting transient usage patterns.

Changes

Tool-runner CLI Alias Support

Layer / File(s) Summary
Console script entry point declaration
pyproject.toml
Adds holoscan-cli console script entry mapping to holoscan_cli.__main__:main in [project.scripts] alongside the existing holoscan entry.
Entry point validation test
tests/unit/test_package_data.py
Updates test module documentation and assertion to verify that pyproject.toml registers both holoscan and holoscan-cli console scripts, both mapped to the same main function.
Local smoke test coverage
.github/scripts/smoke_test.sh
Extends smoke test to validate both holoscan and holoscan-cli entrypoints, running --help and diffing sanitized version output to ensure consistency.
Tool-runner smoke test script
.github/scripts/tool_runner_smoke.sh
Introduces new script to validate holoscan-cli execution via uvx --from and pipx run --spec against a wheel artifact, with prerequisite checks for required tools and isolated temporary state directories.
CI/CD workflow integration
.github/workflows/main.yaml, .github/workflows/release.yaml
Adds tool-runner dependency installation and dedicated smoke test steps to both workflows, running the tool-runner smoke test against built distribution artifacts in dist/.
Documentation update
README.md
Adds subsection documenting transient runner usage for the holoscan-cli alias, with uvx and pipx run examples and variants that preserve the canonical holoscan command name.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Suggested reviewers

  • tbirdso
  • MMelQin
🚥 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 'Add holoscan-cli tool-runner alias' directly and clearly summarizes the main change: introducing a new console-script alias named holoscan-cli to enable tool-runner compatibility while keeping holoscan as the primary command.
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.

@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 @.github/workflows/release.yaml:
- Around line 279-282: Add an explicit least-privilege permissions block to the
smoke-test job so it does not inherit full workflow token rights; in the job
definition that contains the steps "Install tool runners" and "Tool-runner smoke
test" add a permissions entry (e.g., permissions: contents: read) to restrict
the workflow token to only what the job needs and reduce its blast radius.
🪄 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: 4138c290-29c1-478f-bb4d-a11adb39f1c2

📥 Commits

Reviewing files that changed from the base of the PR and between 170b8d6 and 99dfd2d.

📒 Files selected for processing (7)
  • .github/scripts/smoke_test.sh
  • .github/scripts/tool_runner_smoke.sh
  • .github/workflows/main.yaml
  • .github/workflows/release.yaml
  • README.md
  • pyproject.toml
  • tests/unit/test_package_data.py

Comment thread .github/workflows/release.yaml
Comment thread README.md
@wyli wyli merged commit a0416b0 into main Jun 15, 2026
27 checks passed
@wyli wyli deleted the codex-tool-runner-alias branch June 15, 2026 10:53
wyli added a commit that referenced this pull request Jun 15, 2026
Add a holoscan-cli console script alias so package-name based tool runners can execute the CLI directly while keeping holoscan as the canonical command. Extend wheel smoke coverage and CI tool-runner checks for uvx and pipx run.

Co-authored-by: Codex <noreply@openai.com>
(cherry picked from commit a0416b0)
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.

3 participants