Skip to content

chore: prefer Podman for local act container CI#707

Merged
rinchen merged 2 commits into
mainfrom
podman
Jul 23, 2026
Merged

chore: prefer Podman for local act container CI#707
rinchen merged 2 commits into
mainfrom
podman

Conversation

@rinchen

@rinchen rinchen commented Jul 23, 2026

Copy link
Copy Markdown
Member

Summary

  • Prefer Podman (any Docker-compatible engine) for local act container CI instead of assuming Docker Desktop
  • Align docs (AGENTS.md, ci-cd, development-environment, contributing) and install/preflight hints with that policy
  • Make check:environment prefer Podman when both engines are healthy, and report daemon-down vs missing CLI correctly

Test plan

  • pnpm exec vitest run scripts/check-environment.test.mjs scripts/run-act.test.mjs
  • pnpm run check:environment with Podman Desktop running (and optionally with Docker Desktop as fallback)
  • pnpm run act:list / a short act:* target when a container engine is available
  • pnpm run act:ci:native still works without a container engine

Summary by CodeRabbit

  • Documentation

    • Updated local CI and contribution guidance to prefer Podman and clarify Docker-compatible engine usage across Linux/macOS/Windows.
    • Refined macOS/container socket and signing/notarization notes, plus improved troubleshooting for missing or non-running container engines.
  • Improvements

    • Enhanced environment preflight to better detect and diagnose container-engine availability (Podman preferred; Docker fallback).
    • Updated the act runner to use a Docker-compatible container-engine abstraction and generalized messaging.
  • Tests

    • Expanded unit coverage for container-engine detection, selection, diagnostics, and updated Flatpak invocation expectations.

Accept any Docker-compatible engine for act (Podman Desktop preferred) instead of assuming Docker Desktop, and align docs plus environment checks with that policy.
@coderabbitai

coderabbitai Bot commented Jul 23, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: cb3a1bb8-3059-4fcd-8098-a7f89297c45e

📥 Commits

Reviewing files that changed from the base of the PR and between 4e4e7e5 and 54ce4de.

📒 Files selected for processing (5)
  • docs/ci-cd.md
  • docs/development-environment.md
  • scripts/check-environment.mjs
  • scripts/run-act.mjs
  • scripts/run-act.test.mjs
🚧 Files skipped from review as they are similar to previous changes (4)
  • docs/ci-cd.md
  • docs/development-environment.md
  • scripts/check-environment.mjs
  • scripts/run-act.mjs

📝 Walkthrough

Walkthrough

Local CI now supports Docker-compatible engines with Podman preferred. Environment checks select and diagnose available engines, run-act.mjs uses the selected engine and socket, Flatpak arguments are updated, and documentation covers revised local workflows.

Changes

Container Engine Local CI

Layer / File(s) Summary
Container-engine evaluation and diagnostics
scripts/check-environment.mjs, scripts/check-environment.test.mjs
Adds Podman-preferred engine evaluation, readiness diagnostics, installation hints, and coverage for engine-selection scenarios.
Docker-compatible act execution
scripts/run-act.mjs, scripts/run-act.test.mjs
Selects Podman or Docker, validates the engine before container operations, passes the resolved socket to act, and removes obsolete Flatpak matrix arguments.
Local CI guidance
AGENTS.md, docs/ci-cd.md, docs/contributing.md, docs/development-environment.md
Documents container-engine alternatives, host/container modes, Podman Desktop socket handling, expanded act targets, and macOS packaging and signing conditions.

Estimated code review effort: 4 (Complex) | ~45 minutes

Sequence Diagram(s)

sequenceDiagram
  participant Developer
  participant runAct as run-act.mjs
  participant ContainerEngine
  participant act
  Developer->>runAct: invoke local CI target
  runAct->>ContainerEngine: check version and running state
  ContainerEngine-->>runAct: return engine status and socket
  runAct->>ContainerEngine: pull workflow images
  runAct->>act: run workflow with container daemon socket
Loading
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 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: preferring Podman for local act container CI.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch podman

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

@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: 4

🤖 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 `@docs/ci-cd.md`:
- Around line 143-146: Update the Mode table’s Command prefix entries to show
complete executable commands, including “pnpm run” for both container and native
examples. Keep the examples consistent with the package scripts and the explicit
commands documented below, including act:ci and act:tests variants.

In `@docs/development-environment.md`:
- Around line 643-647: Update the Windows row in the OS/container-engine table
to state that Podman Desktop must have Docker compatibility enabled, matching
the macOS requirement while preserving the existing Windows installation
commands and links.

In `@scripts/check-environment.mjs`:
- Around line 466-510: Correct the inaccurate policy comment above the
preferred-engine selection: this helper chooses Podman only when podmanOk
indicates its daemon is ready, whereas run-act.mjs selects based on CLI
presence. Update the comment to describe this helper’s daemon-readiness
preference without claiming it matches CONTAINER_ENGINE.

In `@scripts/run-act.mjs`:
- Around line 22-25: Update the CONTAINER_ENGINE selection to verify Podman
readiness with a successful podman info check, rather than relying only on
commandOk('podman', ['--version']); fall back to Docker when Podman is
unavailable or its machine/daemon is not ready.
🪄 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: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 8ca78c59-b503-4f92-a416-865f83af1b8e

📥 Commits

Reviewing files that changed from the base of the PR and between d44d55e and 4e4e7e5.

📒 Files selected for processing (8)
  • AGENTS.md
  • docs/ci-cd.md
  • docs/contributing.md
  • docs/development-environment.md
  • scripts/check-environment.mjs
  • scripts/check-environment.test.mjs
  • scripts/run-act.mjs
  • scripts/run-act.test.mjs

Comment thread docs/ci-cd.md Outdated
Comment thread docs/development-environment.md Outdated
Comment thread scripts/check-environment.mjs Outdated
Comment thread scripts/run-act.mjs Outdated
Fall back to Docker when Podman CLI exists but its daemon is down, and tighten docs/commands from CodeRabbit review.
@sonarqubecloud

Copy link
Copy Markdown

@rinchen
rinchen merged commit ca0ed73 into main Jul 23, 2026
13 checks passed
@rinchen
rinchen deleted the podman branch July 23, 2026 01:30
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