Implement first working version

pcolby · pcolby · commit cf7021a8f07f · 2024-10-20T18:41:12.000+11:00
Squashed commit of the following: commit 30020d3 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 18:30:55 2024 +1100 Describe the plugin versions in the README.md commit a3db136 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 18:20:41 2024 +1100 Revert "Fail it one time to prove it works" This reverts commit eb01849. commit eb01849 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 18:19:49 2024 +1100 Fail it one time to prove it works commit 8b941c0 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 18:18:23 2024 +1100 Check that all plugins are installed and available commit 1dfba72 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 17:57:21 2024 +1100 Remove debug code commit 7b840db Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 17:53:16 2024 +1100 Gstreamer is raw sh too commit 9951c5b Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 17:51:37 2024 +1100 Gtk is raw sh too commit 047a2a8 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 17:49:57 2024 +1100 Add missing ext separators commit 8ad2000 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 17:48:44 2024 +1100 Add missing `-` for python URL commit b4f24b5 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 17:47:35 2024 +1100 Add missing `}` commit e1534c1 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 17:45:11 2024 +1100 Correct parameter expansion commit 76b29fb Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 17:40:57 2024 +1100 Correct parameter expansion commit b058d54 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 17:39:38 2024 +1100 Correct variable name commit 9332ea2 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 17:38:44 2024 +1100 Add missing `)` commit 25b39a6 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 17:37:27 2024 +1100 Correct typo commit de5fdf3 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 17:36:31 2024 +1100 Refactor the URLs generation to be format based commit 3112054 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 16:04:41 2024 +1100 Allow for raw plugins having a `.sh` extension commit f78c103 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 15:54:39 2024 +1100 Correct variablae name commit 2a1efd5 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 15:51:50 2024 +1100 Allow for conda and ncurses plugins having no releases commit acc7a9b Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 14:45:17 2024 +1100 Omit --remove-on-error for now Since Ubuntu 22.04 does not support it. commit b0c7f4f Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 14:42:40 2024 +1100 Fail on HTTP errors commit bff40b8 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 13:09:24 2024 +1100 Correct path to test file commit ea1ceb8 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 13:07:54 2024 +1100 Remove redundant test commit 26a2fa1 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 13:05:58 2024 +1100 Remvoe the superfluous --binary flag commit 9aa0193 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 13:03:56 2024 +1100 Check sha hashes commit 456a956 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 12:41:26 2024 +1100 Get some checksums commit 5347d61 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 12:29:16 2024 +1100 Correct workflow syntaxf commit cbb799f Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 12:28:04 2024 +1100 Split the check step and improve error logging commit e03f709 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 10:52:27 2024 +1100 Check that the files are *not* executable commit 18c1e6a Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 10:46:39 2024 +1100 Define INSTALL_DIR earlier And use unified diffs commit 00f4a4b Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 10:20:29 2024 +1100 Assign `INSTALL_DIR` in a workflow step Because context vars are not accessible in `env` properties. commit 8e5f026 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 10:14:01 2024 +1100 Use runner.temp because runner.workspace is deprecated Or more specifically: > The `runner.workspace` property is purposefully not documented. > It is an early Actions property that now isn't relevant for > users, compared to `github.workspace`. It is kept around for > compatibility. See https://github.com/github/docs/blob/8c2a58a347a41624dbc3dfea84f0b8d25b67d897/content/actions/learn-github-actions/contexts.md?plain=1#L584C1-L585C36 commit de7c7bf Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 10:01:21 2024 +1100 Default the INPUTS_DIR within Bash commit e8e40bf Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 09:52:02 2024 +1100 Correct CI workflow badge commit 8a6b7a4 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 09:51:17 2024 +1100 Use runner (not GitHub) workspace and runner temp dirs commit 0df2b14 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 09:44:28 2024 +1100 Log the URLs we'll be fetching commit 8f1495d Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 09:42:27 2024 +1100 See what happened to the checkrt plugin commit a49c560 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 09:36:46 2024 +1100 Show the installed files commit 15e9a62 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 09:34:01 2024 +1100 Don't compare `GITHUB_*` env variables commit ae8a16c Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 09:32:02 2024 +1100 Correct page to AppImage commit 8fbf318 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 09:31:11 2024 +1100 Remove erroneous `}` commit 495a134 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 09:29:47 2024 +1100 Ensure env and apt weren't touched commit b790361 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 09:22:38 2024 +1100 Install libfuse2 unless told not to commit 093a7a2 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 09:17:32 2024 +1100 Drop Ubuntu 20.04 support Ubuntu 20.04's curl is tool old for the --output-dir option. commit f7b1219 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 09:16:53 2024 +1100 Download in parallel commit 1100119 Author: Paul Colby <git@colby.id.au> Date: Sun Oct 20 09:08:42 2024 +1100 Build the URLs and binaries lists commit a31f0d5 Author: Paul Colby <git@colby.id.au> Date: Sat Oct 19 23:21:06 2024 +1100 Clean-up some test code commit 744818a Author: Paul Colby <git@colby.id.au> Date: Sat Oct 19 23:19:05 2024 +1100 Test two ways of defaulting the dir option commit 2ad2bdc Author: Paul Colby <git@colby.id.au> Date: Sat Oct 19 23:12:03 2024 +1100 Correct Bash syntax commit 04d7129 Author: Paul Colby <git@colby.id.au> Date: Sat Oct 19 23:10:42 2024 +1100 Correct Bash syntax commit 8369a77 Author: Paul Colby <git@colby.id.au> Date: Sat Oct 19 23:08:57 2024 +1100 Correct workflow syntax commit 7125ebb Author: Paul Colby <git@colby.id.au> Date: Sat Oct 19 23:08:02 2024 +1100 Tweak the README.md slightly commit 27899d4 Author: Paul Colby <git@colby.id.au> Date: Sat Oct 19 23:06:49 2024 +1100 Flesh out the CI workflow
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -0,0 +1,91 @@
+# SPDX-FileCopyrightText: 2024 Paul Colby <git@colby.id.au>
+# SPDX-License-Identifier: MIT
+
+name: CI
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: yamllint .
+
+  test-defaults:
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./
+      - run: linuxdeploy-x86_64.AppImage --list-plugins
+    strategy:
+      matrix:
+        os:
+          - ubuntu-22.04
+          - ubuntu-24.04
+      fail-fast: false
+
+  test-options:
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Define test install dir
+        run: tee -a "$GITHUB_ENV" <<< "INSTALL_DIR=${RUNNER_TEMP}/test/linuxdeploy/bin"
+      - name: Record pre-state
+        run: |
+          apt list --installed > "${RUNNER_TEMP}/apt.pre"
+          env | grep -v '^GITHUB_' | sort > "${RUNNER_TEMP}/env.pre"
+      - name: Install linuxdeploy, overriding all options
+        uses: ./
+        with:
+          arch: i386
+          dir: ${{ env.INSTALL_DIR }}
+          install-deps: false
+          plugins: appimage@1-alpha-20230713-1 qt
+          set-env: false
+          version: 1-alpha-20240109-1
+      - name: Check post-state
+        run: |
+          apt list --installed > "${RUNNER_TEMP}/apt.post"
+          env | grep -v '^GITHUB_' | sort > "${RUNNER_TEMP}/env.post"
+          diff -u "${RUNNER_TEMP}/apt."{pre,post}
+          diff -u "${RUNNER_TEMP}/env."{pre,post}
+      - name: Check installed binaries
+        run: |
+          sha384sum --check <<--
+          695dbdd17adbf8bc0117fc6ad7e7054099965e7c65963b382373ca90d1b0b9409691ff7107d4bb1e83d4790636ce6b8f\
+            ${INSTALL_DIR}/linuxdeploy-i386.AppImage
+          28550e5f1699bc826d645d8f8116575df31d7cc16d2ad566a81d11087695fa1445893c0c3ac464a2cb65808bafdd1acd\
+            ${INSTALL_DIR}/linuxdeploy-plugin-appimage-i386.AppImage
+          a558dcc455997d36fa781ac60ef9bed4cabea4ba716865632fd86460d34de0dc39162cb1de5cd877d2f2d2c16a393003\
+            ${INSTALL_DIR}/linuxdeploy-plugin-qt-i386.AppImage
+          -
+    strategy:
+      matrix:
+        os:
+          - ubuntu-22.04
+          - ubuntu-24.04
+      fail-fast: false
+
+  test-plugins:
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install linuxdeploy, and all supported plugins
+        uses: ./
+        with:
+          plugins: appimage checkrt conda gstreamer gtk native_packages ncurses python qt
+      - name: Check installed plugins
+        run: |
+          ls -l "${RUNNER_TEMP}/linuxdeploy"
+          linuxdeploy-x86_64.AppImage --list-plugins | tee "${RUNNER_TEMP}/plugins.txt"
+          plugins=($(sed -Ee '0,/^Available plugins:/d' -e 's/:.*//' "${RUNNER_TEMP}/plugins.txt" | sort))
+          [[ "${plugins[@]}" = 'appimage checkrt conda gstreamer gtk native_packages ncurses python qt' ]]
+    strategy:
+      matrix:
+        os:
+          - ubuntu-22.04
+          - ubuntu-24.04
+      fail-fast: false
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # `install-linuxdeploy-action`
 
-[![CI](https://github.com/pcolby/install-linuxdeploy-action/actions/workflows/test.yaml/badge.svg?branch=main)](
-  https://github.com/pcolby/pcolby/install-linuxdeploy-action/actions/workflows/test.yaml)
+[![CI](https://github.com/pcolby/install-linuxdeploy-action/actions/workflows/ci.yaml/badge.svg?branch=main)](
+  https://github.com/pcolby/pcolby/install-linuxdeploy-action/actions/workflows/ci.yaml)
 
 GitHub Action for installing [linuxdeploy] with optional plugins.
 
@@ -20,7 +20,7 @@ for, but typically you'd want to leave it to default to `x86_64`.
 
 ### `dir`
 
-The target directory to install [linuxdeploy] to. Defaults to `${GITHUB_WORKSPACE}/linuxdeploy`.
+The target directory to install [linuxdeploy] to. Defaults to `${RUNNER_TEMP}/linuxdeploy`.
 
 ### `install-deps`
 
@@ -31,6 +31,12 @@ Whether or not to install known `apt` dependencies. Defaults to `true`.
 Space-separated list of optional [linuxdeploy] plugins to install. Any plugins directly listed in the
 [Awesome linuxdeploy!] listing should be supported, such as `appimage` and `qt`.
 
+Each plugin may be suffixed with a version, like `qt@v1.2.3`, to specify which version of that plugin to install. Note,
+however, for plugins with actual releases (such as `appimage` and `qt`), the version is a GitHub release tag, but for
+unreleased plugins (such as `gtk` and `gstreamer`) the version is a ref name or commit hash. If no version suffix is
+provided, released plugins default to match the [`version`](#version) option, while unreleased plugins defualt to their
+default branch (ie `master`).
+
 ### `set-env`
 
 Whether or not to update the `$PATH` environment variable to include the installation `dir`. Defaults to `true`.
@@ -41,8 +47,8 @@ The [linuxdeploy] version to install, as well as the _default_ version for any `
 version.
 
 > [!IMPORTANT]
-> Currently this defaults to `continuous`, as [linuxdeploy] currently has no official stable release, but at some point
-> this will likely default to the most recent, current, tested stable [linuxdeploy] version.
+> Currently this defaults to `continuous`, as [linuxdeploy] has no official stable release yet. But at some point
+> this will likely default to the most recent stable [linuxdeploy] version that has been tested with this action.
 
 ### Example with all options
 
@@ -51,9 +57,9 @@ version.
   uses: pcolby/install-linuxdeploy-action@v1
   with:
     arch: x86_64
-    dir: ${{ github.workspace }}/linuxdeploy
+    dir: ${{ runner.temp }}/linuxdeploy
     install-deps: true
-    plugins: qt
+    plugins: appimage gtk@master qt
     set-env: true
     version: continuous
 ```
diff --git a/action.yaml b/action.yaml
@@ -13,7 +13,7 @@ inputs:
     default: x86_64
   dir:
     description: Target directory to install linuxdeploy
-    required: false
+    default: ${{ runner.temp }}/linuxdeploy
   install-deps:
     description: Install known OS dependencies
     default: true
@@ -32,11 +32,36 @@ runs:
   steps:
     - run: |
         set -o errexit -o noclobber -o nounset -o pipefail
-        [[ ${INPUTS_INSTALL_DEPS}" = 'false' ]] || echo '\todo: install dependencies'
-        # \todo Build URLs list, and binaries list (using arch, plugins, version)
-        curl --create-dirs --location --output-dir "${INPUTS_DIR}" --remote-name-all "${urls[@}}"
-        chmod a+x "${binaries}"
+        [[ "${INPUTS_INSTALL_DEPS}" = 'false' ]] || sudo apt --assume-yes install libfuse2
+        declare -r RELEASE_FORMAT='https://github.com/%s/%s/releases/download/%%s/%s'
+        declare -r RAW_FORMAT='https://raw.githubusercontent.com/%s/%s/%%s/%s'
+        declare -Ar PLUGIN_FORMAT=(
+          [checkrt]=$(printf "${RELEASE_FORMAT}" darealshinji linuxdeploy-plugin-checkrt{,.sh})
+          [conda]=$(printf "${RAW_FORMAT}" linuxdeploy linuxdeploy-plugin-conda{,.sh})
+          [gstreamer]=$(printf "${RAW_FORMAT}" linuxdeploy linuxdeploy-plugin-gstreamer{,.sh})
+          [gtk]=$(printf "${RAW_FORMAT}" linuxdeploy linuxdeploy-plugin-gtk{,.sh})
+          [ncurses]=$(printf "${RAW_FORMAT}" linuxdeploy linuxdeploy-plugin-ncurses{,.sh})
+          [python]=$(printf "${RELEASE_FORMAT}" niess linuxdeploy-plugin-python{,-${INPUTS_ARCH}.AppImage})
+        )
+        declare -a binaries=("${INPUTS_DIR}/linuxdeploy-${INPUTS_ARCH}.AppImage")
+        declare -a urls=(
+          $(printf "$(printf "${RELEASE_FORMAT}" linuxdeploy{,,-${INPUTS_ARCH}.AppImage})" "${INPUTS_VERSION}")
+        )
+        for plugin in ${INPUTS_PLUGINS}; do
+          IFS='@' read -r name version <<< "${plugin}"
+          [[ -v "PLUGIN_FORMAT[${name}]" ]] && urlFormat="${PLUGIN_FORMAT[${name}]}" ||
+            urlFormat=$(printf "${RELEASE_FORMAT}" linuxdeploy{,-plugin-${name}{,-${INPUTS_ARCH}.AppImage}})
+          [[ "${urlFormat}" == 'https://raw.'* ]] && : "${version:=master}" || : "${version:=${INPUTS_VERSION}}"
+          printf -v url "${urlFormat}" "${version}"
+          binaries+=("${INPUTS_DIR}/${url##*/}")
+          urls+=("${url}")
+        done
+        printf "%s\n" "${urls[@]}"
+        curl --create-dirs --fail --fail-early --location --output-dir "${INPUTS_DIR}" --parallel --remote-name-all \
+          --silent --write-out '[%{urlnum}][%{http_code}] %{errormsg}: %{url}\n' "${urls[@]}"
+        chmod a+x "${binaries[@]}"
         [[ "${INPUTS_SET_ENV}" = 'false' ]] || tee -a "${GITHUB_PATH}" <<< "${INPUTS_DIR}"
+        ls -l "${INPUTS_DIR}"
       shell: bash
       env:
         INPUTS_ARCH: ${{ inputs.arch }}
