Skip to content

docs: add a runnable QEMU usage example #258

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

Open
rinadavidyuk826-sudo wants to merge 1 commit into
base: master
Choose a base branch
from
+28 −0
Open

docs: add a runnable QEMU usage example #258

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 28 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,34 @@ jobs:
uses: docker/setup-qemu-action@v4
```

This action registers QEMU emulators with `binfmt_misc`, so later steps can run
containers built for another architecture on the GitHub-hosted runner.

```yaml
name: run-cross-platform-container

on:
workflow_dispatch:

jobs:
qemu-example:
runs-on: ubuntu-latest
steps:
-
name: Set up QEMU
uses: docker/setup-qemu-action@v4
-
name: Run an arm64 container
run: docker run --rm --platform linux/arm64 alpine uname -m
```

The command above prints `aarch64` even though the job itself is running on
`ubuntu-latest`.

> [!TIP]
> `setup-qemu-action` enables user-mode emulation for registered platforms. It
> does not install `qemu-system-*` tools or add `qemu-*` binaries to your PATH.

> [!NOTE]
> If you are using [`docker/setup-buildx-action`](https://github.com/docker/setup-buildx-action),
> this action should come before it:
Expand Down