https://github.com/docker/setup-qemu-action

GitHub Action to install QEMU static binaries
https://github.com/docker/setup-qemu-action

binfmt-misc docker github-actions github-actions-docker qemu

Last synced: about 16 hours ago
JSON representation

GitHub Action to install QEMU static binaries

• Host: GitHub
• URL: https://github.com/docker/setup-qemu-action
• Owner: docker
• License: apache-2.0
• Created: 2020-08-18T15:04:37.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-12-17T06:02:07.000Z (29 days ago)
• Last Synced: 2025-01-07T19:06:37.188Z (8 days ago)
• Topics: binfmt-misc, docker, github-actions, github-actions-docker, qemu
• Language: TypeScript
• Homepage: https://github.com/marketplace/actions/docker-setup-qemu
• Size: 10.6 MB
• Stars: 472
• Watchers: 14
• Forks: 64
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Security: .github/SECURITY.md

Awesome Lists containing this project

• awesome-repositories - docker/setup-qemu-action - GitHub Action to install QEMU static binaries (TypeScript)

README

        
[![GitHub release](https://img.shields.io/github/release/docker/setup-qemu-action.svg?style=flat-square)](https://github.com/docker/setup-qemu-action/releases/latest)

[![GitHub marketplace](https://img.shields.io/badge/marketplace-docker--setup--qemu-blue?logo=github&style=flat-square)](https://github.com/marketplace/actions/docker-setup-qemu)

[![CI workflow](https://img.shields.io/github/actions/workflow/status/docker/setup-qemu-action/ci.yml?branch=master&label=ci&logo=github&style=flat-square)](https://github.com/docker/setup-qemu-action/actions?workflow=ci)

[![Test workflow](https://img.shields.io/github/actions/workflow/status/docker/setup-qemu-action/test.yml?branch=master&label=test&logo=github&style=flat-square)](https://github.com/docker/setup-qemu-action/actions?workflow=test)

[![Codecov](https://img.shields.io/codecov/c/github/docker/setup-qemu-action?logo=codecov&style=flat-square)](https://codecov.io/gh/docker/setup-qemu-action)

## About

GitHub Action to install [QEMU](https://github.com/qemu/qemu) static binaries.

![Screenshot](.github/setup-qemu-action.png)

___

* [Usage](#usage)

* [Customizing](#customizing)

  * [inputs](#inputs)

  * [outputs](#outputs)

* [Contributing](#contributing)

## Usage

```yaml

name: ci

on:

  push:

jobs:

  qemu:

    runs-on: ubuntu-latest

    steps:

      -

        name: Set up QEMU

        uses: docker/setup-qemu-action@v3

```

## Customizing

### inputs

The following inputs can be used as `step.with` keys:

| Name          | Type   | Default                                                                       | Description                                        |

|---------------|--------|-------------------------------------------------------------------------------|----------------------------------------------------|

| `image`       | String | [`tonistiigi/binfmt:latest`](https://hub.docker.com/r/tonistiigi/binfmt/tags) | QEMU static binaries Docker image                  |

| `platforms`   | String | `all`                                                                         | Platforms to install (e.g., `arm64,riscv64,arm`)   |

| `cache-image` | Bool   | `true`                                                                        | Cache binfmt image to GitHub Actions cache backend |

### outputs

The following outputs are available:

| Name          | Type    | Description                           |

|---------------|---------|---------------------------------------|

| `platforms`   | String  | Available platforms (comma separated) |

## Contributing

Want to contribute? Awesome! You can find information about contributing to

this project in the [CONTRIBUTING.md](/.github/CONTRIBUTING.md)