GitHub Action
Snapcraft Multiarch Build
This is a Github Action that can be used to build a Snapcraft project. For most projects, the following workflow should be sufficient:
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: diddlesnaps/snapcraft-multiarch-action@v1
This will run snapcraft
using the snapcraft-container
On success, the action will set the snap
output parameter to the
path of the built snap. This can be used to save it as an artifact of
the workflow:
...
- uses: diddlesnaps/snapcraft-multiarch-action@v1
id: snapcraft
- uses: actions/upload-artifact@v2
with:
name: snap
path: ${{ steps.snapcraft.outputs.snap }}
Alternatively, it could be used to perform further testing on the built snap:
- run: |
sudo snap install --dangerous ${{ steps.snapcraft.outputs.snap }}
# do something with the snap
The action can also be chained with
snapcore/action-publish@v1
to automatically publish builds to the Snap Store.
This action supports building for multiple architectures using the GitHub Actions matrix feature.
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
platform:
- i386
- amd64
- armhf
- arm64
- ppc64el
- s390x
steps:
- uses: actions/checkout@v3
- uses: docker/setup-qemu-action@v1
- uses: diddlesnaps/snapcraft-multiarch-action@v1
with:
architecture: ${{ matrix.platform }}
s390x
is broken at the moment.- Builds for
core20
, and later, do not supporti386
architecture because Ubuntu has dropped support fori386
in Ubuntu 20.04 and later. core
builds do not supports390x
architecture because Ubuntu does not have support fors390x
before Ubuntu 18.04.
If your Snapcraft project is not located in the root of the workspace,
you can specify an alternative location via the path
input
parameter:
...
- uses: diddlesnaps/snapcraft-multiarch-action@v1
with:
path: path-to-snapcraft-project
By default, this action will use Docker. If you are running a self-hosted GitHub Actions Runner then you might prefer to use Podman instead. This switch allows you to request experimental support for Podman to be used.
Note that when using Podman your build cannot target a CPU architecture that is different to the host your runner is based upon. This is a limitation of Podman. For example, you will need an ARM64 host to build an ARM64 Snap Package, when using Podman builds. Multiarch builds, where you build an i386 Snap on an AMD64 host or an ARMHF Snap on an ARM64 host, might be possible but are untested - your mileage might vary.
Set use-podman
to true
to use Podman instead of Docker.
By default, the action will tell Snapcraft to include information
about the build in the resulting snap, in the form of the
snap/snapcraft.yaml
and snap/manifest.yaml
files. Among other
things, these are used by the Snap Store's automatic security
vulnerability scanner to check whether your snap includes files from
vulnerable versions of Ubuntu packages.
This can be turned off by setting the build-info
parameter to
false
.
By default, the action will install Snapcraft from the stable
channel. If your project relies on a feature not found in the stable
version of Snapcraft, then the snapcraft-channel
parameter can be
used to select a different channel.
The snapcraft-args
parameter can be used to pass additional
arguments to Snapcraft. This is primarily intended to allow the use
of experimental features by passing --enable-experimental-*
arguments to Snapcraft.
By default, the action will build for AMD64. You may use this parameter
to indicate an alternative architecture from any of those supported by
the snapcraft
utility. At the time of writing the supported
architectures are amd64
, i386
, arm64
, armhf
, ppc64el
and s390x
.
This is most-useful when used with GitHub Actions' matrix
feature.
### environment
Add environment variables to the Snapcraft build context. Each variable needs to be specified on a separate line. For example:
with:
environment: |
FOO=bar
BAZ=qux
Set the SNAPCRAFT_STORE_CREDENTIALS
environment variable. This
is useful when using the snapcraft push
command.
You should not save the token into the yaml file directly, but use the GitHub Actions secrets feature:
with:
store-auth: ${{ secrets.STORE_AUTH }}