flatpak-builder: Allow specifying CPU arch

Author: davidmhewitt

README.md

@@ -8,7 +8,7 @@ Build and deploy your Flatpak application using Github Actions
   <img src="https://user-images.githubusercontent.com/15098724/55282117-f8253380-52fa-11e9-95a3-ccae83b23034.png" alt="Flatpak logo" />
 </p>
 
-## How to use  
+## How to use
 
 ### Building stage
 
@@ -48,6 +48,50 @@ jobs:
 | `branch` | The default flatpak branch  | Optional | `master` |
 | `cache` | Enable/Disable caching `.flatpak-builder` directory | Optional | `true` |
 | `cache-key` | Specifies the cache key | Optional | `flatpak-builder-${sha256(manifestPath)}` |
+| `arch` | Specifies the CPU architecture to build for | Optional | `x86_64` |
+
+#### Building for multiple CPU architectures
+
+To build for CPU architectures other than `x86_64`, the GitHub Actions workflow has to either natively be running on that architecture (e.g. on an `aarch64` self-hosted GitHub Actions runner), or the container used must be configured to emulate the requested architecture (e.g. with QEMU).
+
+For example, to built a Flatpak for both `x86_64` and `aarch64` using emulation, use the following workflow as a guide:
+
+```yaml
+on:
+  push:
+    branches: [main]
+  pull_request:
+name: CI
+jobs:
+  flatpak:
+    name: "Flatpak"
+    runs-on: ubuntu-latest
+    container:
+      image: bilelmoussaoui/flatpak-github-actions:gnome-40
+      options: --privileged
+    strategy:
+      matrix:
+        arch: [x86_64, aarch64]
+      # Don't fail the whole workflow if one architecture fails
+      fail-fast: false
+    steps:
+    - uses: actions/checkout@v2
+    # Docker is required by the docker/setup-qemu-action which enables emulation
+    - name: Install deps
+      run: |
+        dnf -y install docker
+    - name: Set up QEMU
+      id: qemu
+      uses: docker/setup-qemu-action@v1
+      with:
+        platforms: arm64
+    - uses: bilelmoussaoui/flatpak-github-actions/flatpak-builder@v4
+      with:
+        bundle: palette.flatpak
+        manifest-path: org.gnome.zbrown.Palette.yml
+        cache-key: flatpak-builder-${{ github.sha }}
+        arch: ${{ matrix.arch }}
+```
 
 ### Deployment stage
 

flatpak-builder/action.yml

@@ -32,7 +32,7 @@ inputs:
     required: false
   cache:
     description: >
-      Toggles caching the flatpak-builder directory. 
+      Toggles caching the flatpak-builder directory.
       Possible values: true, enabled, yes, y. Or something else to disable it.
     default: "true"
     required: false
@@ -45,6 +45,11 @@ inputs:
     description: The flatpak branch.
     default: "master"
     required: false
+  arch:
+    description: >
+      The CPU architecture to build for.
+    default: "x86_64"
+    required: false
 runs:
   using: "node12"
   main: "dist/index.js"

flatpak-builder/dist/index.js

@@ -125,8 +125,9 @@ const modifyManifest = (manifest, runTests = false) => {
  * @param {string} localRepoName The flatpak repository name
  * @param {boolean} cacheBuildDir Whether to enable caching the build directory
  * @param {string} cacheKey The key used to cache the build directory
+ * @param {string} arch The CPU architecture to build for
  */
-const build = async (manifest, manifestPath, bundle, repositoryUrl, repositoryName, buildDir, localRepoName, cacheBuildDir, cacheKey) => {
+const build = async (manifest, manifestPath, bundle, repositoryUrl, repositoryName, buildDir, localRepoName, cacheBuildDir, cacheKey, arch) => {
   const appId = manifest['app-id'] || manifest.id
   const branch = manifest.branch || core.getInput('branch') || 'master'
 
@@ -137,7 +138,8 @@ const build = async (manifest, manifestPath, bundle, repositoryUrl, repositoryNa
         '--disable-rofiles-fuse',
         `--install-deps-from=${repositoryName}`,
         '--force-clean',
-        `--default-branch=${branch}`
+        `--default-branch=${branch}`,
+        `--arch=${arch}`
   ]
   if (cacheBuildDir) {
     args.push('--ccache')
@@ -160,6 +162,7 @@ const build = async (manifest, manifestPath, bundle, repositoryUrl, repositoryNa
     localRepoName,
     bundle,
         `--runtime-repo=${repositoryUrl}`,
+        `--arch=${arch}`,
         appId,
         branch
   ])
@@ -175,9 +178,10 @@ const build = async (manifest, manifestPath, bundle, repositoryUrl, repositoryNa
  * @param {PathLike} manifestPath the manifest path
  * @param {Boolean} cacheBuildDir whether to cache the build dir or not
  * @param {string | undefined} cacheKey the default cache key if there are any
+ * @param {string} arch The CPU architecture to build for
  * @returns {Promise<String>} the new cacheKey if none was set before
  */
-const prepareBuild = async (repositoryName, repositoryUrl, manifestPath, cacheBuildDir, cacheKey = undefined) => {
+const prepareBuild = async (repositoryName, repositoryUrl, manifestPath, cacheBuildDir, cacheKey = undefined, arch) => {
   /// If the user has set a different runtime source
   if (repositoryUrl !== 'https://flathub.org/repo/flathub.flatpakrepo') {
     await exec.exec('flatpak', ['remote-add', '--if-not-exists', repositoryName, repositoryUrl])
@@ -204,7 +208,8 @@ const prepareBuild = async (repositoryName, repositoryUrl, manifestPath, cacheBu
       core.info('No cache was found')
     }
   }
-  return cacheKey
+  // Ensure the cache key is unique if we're building multiple architectures in the same job
+  return `${cacheKey}-${arch}`
 }
 
 /**
@@ -219,6 +224,7 @@ const prepareBuild = async (repositoryName, repositoryUrl, manifestPath, cacheBu
  * @param {string} localRepoName The flatpak repository name
  * @param {boolean} cacheBuildDir Whether to enable caching the build directory
  * @param {string | undefined} cacheKey the default cache key if there are any
+ * @param {string} arch The CPU architecture to build for
  */
 const run = async (
   manifestPath,
@@ -229,10 +235,11 @@ const run = async (
   buildDir,
   localRepoName,
   cacheBuildDir,
-  cacheKey = undefined
+  cacheKey = undefined,
+  arch
 ) => {
   try {
-    cacheKey = await prepareBuild(repositoryName, repositoryUrl, manifestPath, cacheBuildDir, cacheKey)
+    cacheKey = await prepareBuild(repositoryName, repositoryUrl, manifestPath, cacheBuildDir, cacheKey, arch)
   } catch (err) {
     core.setFailed(`Failed to prepare the build ${err}`)
   }
@@ -243,13 +250,15 @@ const run = async (
       return saveManifest(modifiedManifest, manifestPath)
     })
     .then((manifest) => {
-      return build(manifest, manifestPath, bundle, repositoryUrl, repositoryName, buildDir, localRepoName, cacheBuildDir, cacheKey)
+      return build(manifest, manifestPath, bundle, repositoryUrl, repositoryName, buildDir, localRepoName, cacheBuildDir, cacheKey, arch)
     })
     .then(() => {
       core.info('Uploading artifact...')
       const artifactClient = artifact.create()
 
-      return artifactClient.uploadArtifact(bundle.replace('.flatpak', ''), [bundle], '.', {
+      // Append the arch to the bundle name to prevent conflicts in multi-arch jobs
+      const bundleName = bundle.replace('.flatpak', '') + `-${arch}`
+      return artifactClient.uploadArtifact(bundleName, [bundle], '.', {
         continueOnError: false
       })
     })
@@ -277,6 +286,7 @@ if (require.main === module) {
     'flatpak_app',
     'repo',
     ['y', 'yes', 'true', 'enabled', true].includes(core.getInput('cache')),
-    core.getInput('cache-key')
+    core.getInput('cache-key'),
+    core.getInput('arch')
   )
 }