Skip to content

docs/ci: Renode driver listing and conditional macOS Renode install #557

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mangelajo merged 2 commits into from
Apr 15, 2026
Merged

docs/ci: Renode driver listing and conditional macOS Renode install #557

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2600a42
docs: list Renode driver and drop broken ADR link
mangelajo Apr 15, 2026
505f243
ci: install Renode on macOS only when Renode driver changes
mangelajo Apr 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion .github/workflows/python-tests.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ jobs:
runs-on: ubuntu-latest
outputs:
should_run: ${{ steps.filter.outputs.python }}
renode_driver: ${{ steps.filter.outputs.renode_driver }}
steps:
- uses: actions/checkout@v4
with:
Expand All @@ -31,6 +32,8 @@ jobs:
python:
- 'python/**'
- '.github/workflows/python-tests.yaml'
renode_driver:
- 'python/packages/jumpstarter-driver-renode/**'

pytest-matrix:
needs: changes
Expand Down Expand Up @@ -84,8 +87,14 @@ jobs:
run: |
brew install qemu

# Homebrew Renode is slow (~5+ minutes per job). Install on macOS only when this run
# touches the Renode driver, or on workflow_dispatch (full manual run). Linux still
# installs Renode from the .deb in all jobs (fast).
- name: Install Renode (macOS)
if: runner.os == 'macOS'
if: >-
runner.os == 'macOS'
&& (needs.changes.outputs.renode_driver == 'true'
|| github.event_name == 'workflow_dispatch')
run: |
brew install renode/tap/renode

Expand Down
2 changes: 2 additions & 0 deletions python/docs/source/reference/package-apis/drivers/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ Drivers for debugging and programming devices:
* **[Android Emulator](androidemulator.md)** (`jumpstarter-driver-androidemulator`) -
Android emulator lifecycle management with ADB tunneling
* **[QEMU](qemu.md)** (`jumpstarter-driver-qemu`) - QEMU virtualization platform
* **[Renode](renode.md)** (`jumpstarter-driver-renode`) - Renode embedded systems emulation
* **[Corellium](corellium.md)** (`jumpstarter-driver-corellium`) - Corellium
virtualization platform
* **[U-Boot](uboot.md)** (`jumpstarter-driver-uboot`) - Universal Bootloader
Expand Down Expand Up @@ -136,6 +137,7 @@ power.md
probe-rs.md
pyserial.md
qemu.md
renode.md
gpiod.md
ridesx.md
sdwire.md
Expand Down
3 changes: 0 additions & 3 deletions python/packages/jumpstarter-driver-renode/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,9 +112,6 @@ The `monitor` CLI subcommand is also available inside a `jmp shell` session.

## Design Decisions

The architectural choices for this driver are documented in
[ADR-0001: Renode Integration Approach](../../docs/source/contributing/adr/0001-renode-integration.md).

Comment on lines -115 to -117
Copy link
Copy Markdown
Member Author

@mangelajo mangelajo Apr 15, 2026

Choose a reason for hiding this comment

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

the doc is in the internal directory and can't be grabbed by sphinx

Key decisions:

- **Control interface**: Telnet monitor via `anyio.connect_tcp` (no
Expand Down
Loading