A Github Action that executes jobs/commands on non-x86 cpu architectures (ARMv6, ARMv7, aarch64, s390x, ppc64le)
A GitHub Action that executes commands on non-x86 CPU architecture (armv6, armv7, aarch64, s390x, ppc64le).
This action requires three input parameters:
arch: CPU architecture:
armv6,
armv7,
aarch64,
s390x, or
ppc64le. See Supported Platforms for the full matrix.
distro: Linux distribution name:
ubuntu16.04,
ubuntu18.04,
ubuntu20.04,
buster,
stretch,
jessie,
fedora_latest, or
alpine_latest. See Supported Platforms for the full matrix.
run: Shell commands to execute in the container.
The action also accepts some optional input parameters:
githubToken: Your GitHub token, used for caching Docker images in your project's public package registry. Usually this would just be
${{ github.token }}. This speeds up subsequent builds and is highly recommended.
env: Environment variables to propagate to the container. YAML, but must begin with a
|character. These variables will be available in both run and setup.
shell: The shell to run commands with in the container. Default:
/bin/shon Alpine,
/bin/bashfor other distros.
dockerRunArgs: Additional arguments to pass to
docker run, such as volume mappings. See
docker rundocumentation.
setup: Shell commands to execute on the host before running the container, such as creating directories for volume mappings.
install: Shell commands to execute in the container as part of
docker build, such as installing dependencies. This speeds up subsequent builds if
githubTokenis also used, but note that the image layer will be publicly available in your projects GitHub Package Registry, so make sure the resulting image does not have any secrets cached in logs or state.
A basic example that sets an output variable for use in subsequent steps:
on: [push, pull_request]jobs: armv7_job: # The host should always be Linux runs-on: ubuntu-18.04 name: Build on ubuntu-18.04 armv7 steps: - uses: actions/[email protected] - uses: uraimo/[email protected] name: Run commands id: runcmd with: arch: armv7 distro: ubuntu18.04
# Not required, but speeds up builds by storing container images in # a GitHub package registry. githubToken: ${{ github.token }} # Set an output parameter `uname` for use in subsequent steps run: | uname -a echo ::set-output name=uname::$(uname -a) - name: Get the output # Echo the `uname` output parameter from the `runcmd` step run: | echo "The uname output was ${{ steps.runcmd.outputs.uname }}"
This shows how to use a matrix to produce platform-specific artifacts, and includes example values for the optional input parameters
setup,
shell,
env, and
dockerRunArgs.
on: [push, pull_request]jobs: build_job: # The host should always be linux runs-on: ubuntu-18.04 name: Build on ${{ matrix.distro }} ${{ matrix.arch }}
# Run steps on a matrix of 3 arch/distro combinations strategy: matrix: include: - arch: aarch64 distro: ubuntu18.04 - arch: ppc64le distro: alpine_latest - arch: s390x distro: fedora_latest steps: - uses: actions/[email protected] - uses: uraimo/[email protected] name: Build artifact id: build with: arch: ${{ matrix.arch }} distro: ${{ matrix.distro }} # Not required, but speeds up builds githubToken: ${{ github.token }} # Create an artifacts directory setup: | mkdir -p "${PWD}/artifacts" # Mount the artifacts directory as /artifacts in the container dockerRunArgs: | --volume "${PWD}/artifacts:/artifacts" # Pass some environment variables to the container env: | # YAML, but pipe character is necessary artifact_name: git-${{ matrix.distro }}_${{ matrix.arch }} # The shell to run commands with in the container shell: /bin/sh # Install some dependencies in the container. This speeds up builds if # you are also using githubToken. Any dependencies installed here will # be part of the container image that gets cached, so subsequent # builds don't have to re-install them. The image layer is cached # publicly in your project's package repository, so it is vital that # no secrets are present in the container state or logs. install: | case "${{ matrix.distro }}" in ubuntu*|jessie|stretch|buster) apt-get update -q -y apt-get install -q -y git ;; fedora*) dnf -y update dnf -y install git which ;; alpine*) apk update apk add git ;; esac # Produce a binary artifact and place it in the mounted volume run: | cp $(which git) "/artifacts/${artifact_name}" echo "Produced artifact at /artifacts/${artifact_name}" - name: Show the artifact # Items placed in /artifacts in the container will be in # ${PWD}/artifacts on the host. run: | ls -al "${PWD}/artifacts"
This table details the valid
arch/
distrocombinations:
| arch | distro | | -------- | ---------- | | armv6 | jessie, stretch, buster, alpinelatest | | armv7 | jessie, stretch, buster, ubuntu16.04, ubuntu18.04, ubuntu20.04, fedoralatest, alpinelatest | | aarch64 | stretch, buster, ubuntu16.04, ubuntu18.04, ubuntu20.04, fedoralatest, alpinelatest | | s390x | jessie, stretch, buster, ubuntu16.04, ubuntu18.04, ubuntu20.04, fedoralatest, alpinelatest | | ppc64le | jessie, stretch, buster, ubuntu16.04, ubuntu18.04,ubuntu20.04, fedoralatest, alpine_latest |
Using an invalid
arch/
distrocombination will fail.
New distros and archs can be added simply by creating a Dockerfile named
Dockerfile.{arch}.{distro}(that targets an image for the desired combination) in the Dockerfiles directory. Pull requests welcome!
This project is licensed under the BSD 3-Clause License.