Implement auto-updater

.github/workflows/updater.sh

@@ -0,0 +1,145 @@
+#!/bin/bash
+
+#=================================================
+# PACKAGE UPDATING HELPER
+#=================================================
+
+# This script is meant to be run by GitHub Actions
+# The YunoHost-Apps organisation offers a template Action to run this script periodically
+# Since each app is different, maintainers can adapt its contents so as to perform
+# automatic actions when a new upstream release is detected.
+
+#=================================================
+# FETCHING LATEST RELEASE AND ITS ASSETS
+#=================================================
+
+# Fetching information
+current_version=$(cat manifest.json | jq -j '.version|split("~")[0]')
+# Some jq magic is needed, because the latest upstream release is not always the latest version (e.g. security patches for older versions)
+version=$(curl --silent "https://gitlab.com/api/v4/projects/250833/releases" | jq -r '.[] | select( .prerelease != true ) | .tag_name' | sort -V | tail -1)
+assets=($(curl --silent "https://gitlab.com/api/v4/projects/250833/releases" | jq -r '[ .[] | select(.tag_name=="'$version'").assets.links[].direct_asset_url ] | join(" ") | @sh' | tr -d "'"))
+
+# Later down the script, we assume the version has only digits and dots
+# Sometimes the release name starts with a "v", so let's filter it out.
+# You may need more tweaks here if the upstream repository has different naming conventions.
+if [[ ${version:0:1} == "v" || ${version:0:1} == "V" ]]; then
+    version=${version:1}
+fi
+
+# Setting up the environment variables
+echo "Current version: $current_version"
+echo "Latest release from upstream: $version"
+echo "VERSION=$version" >> $GITHUB_ENV
+# For the time being, let's assume the script will fail
+echo "PROCEED=false" >> $GITHUB_ENV
+
+# Proceed only if the retrieved version is greater than the current one
+if ! dpkg --compare-versions "$current_version" "lt" "$version" ; then
+    echo "::warning ::No new version available"
+    exit 0
+# Proceed only if a PR for this new version does not already exist
+elif git ls-remote -q --exit-code --heads https://github.com/$GITHUB_REPOSITORY.git ci-auto-update-v$version ; then
+    echo "::warning ::A branch already exists for this update"
+    exit 0
+fi
+
+# Each release can hold multiple assets (e.g. binaries for different architectures, source code, etc.)
+echo "${#assets[@]} available asset(s)"
+
+#=================================================
+# UPDATE SOURCE FILES
+#=================================================
+
+# Here we use the $assets variable to get the resources published in the upstream release.
+# Here is an example for Grav, it has to be adapted in accordance with how the upstream releases look like.
+
+# Let's loop over the array of assets URLs
+for asset_url in ${assets[@]}; do
+
+echo "Handling asset at $asset_url"
+
+# Assign the asset to a source file in conf/ directory
+# Here we base the source file name upon a unique keyword in the assets url (admin vs. update)
+# Leave $src empty to ignore the asset
+case $asset_url in
+  *"arm64.deb"*)
+    src="arm64"
+    ;;
+  *"aarch64.deb"*)
+    src="aarch64"
+    ;;
+  *"armhf.deb"*)
+    src="armhf"
+    ;;
+  *"armel.deb"*)
+    src="armel"
+    ;;
+  *"i386.deb"*)
+    src="i386"
+    ;;
+  *"amd64.deb"*)
+    src="amd64"
+    ;;
+  *)
+    src=""
+    ;;
+esac
+
+# If $src is not empty, let's process the asset
+if [ ! -z "$src" ]; then
+
+# Create the temporary directory
+tempdir="$(mktemp -d)"
+
+# Download sources and calculate checksum
+filename=${asset_url##*/}
+curl --silent -4 -L $asset_url -o "$tempdir/$filename"
+checksum=$(sha256sum "$tempdir/$filename" | head -c 64)
+
+# Delete temporary directory
+rm -rf $tempdir
+
+# Get extension
+if [[ $filename == *.tar.gz ]]; then
+  extension=tar.gz
+else
+  extension=${filename##*.}
+fi
+
+# Rewrite source file
+cat <<EOT > conf/$src.src
+SOURCE_URL=$asset_url
+SOURCE_SUM=$checksum
+SOURCE_SUM_PRG=sha256sum
+SOURCE_FORMAT=$extension
+SOURCE_IN_SUBDIR=false
+SOURCE_FILENAME=gitlab-runner.deb
+SOURCE_EXTRACT=false
+EOT
+echo "... conf/$src.src updated"
+
+else
+echo "... asset ignored"
+fi
+
+done
+
+#=================================================
+# SPECIFIC UPDATE STEPS
+#=================================================
+
+# Any action on the app's source code can be done.
+# The GitHub Action workflow takes care of committing all changes after this script ends.
+
+#=================================================
+# GENERIC FINALIZATION
+#=================================================
+
+# Replace new version in manifest
+echo "$(jq -s --indent 4 ".[] | .version = \"$version~ynh1\"" manifest.json)" > manifest.json
+
+# No need to update the README, yunohost-bot takes care of it
+
+# The Action will proceed only if the PROCEED environment variable is set to true
+echo "PROCEED=true" >> $GITHUB_ENV
+exit 0

.github/workflows/updater.yml

@@ -0,0 +1,49 @@
+# This workflow allows GitHub Actions to automagically update your app whenever a new upstream release is detected.
+# You need to enable Actions in your repository settings, and fetch this Action from the YunoHost-Apps organization.
+# This file should be enough by itself, but feel free to tune it to your needs.
+# It calls updater.sh, which is where you should put the app-specific update steps.
+name: Check for new upstream releases
+on:
+  # Allow to manually trigger the workflow
+  workflow_dispatch:
+  # Run it every day at 6:00 UTC
+  schedule:
+    - cron:  '0 6 * * *'
+jobs:
+  updater:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Fetch the source code
+        uses: actions/checkout@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Run the updater script
+        id: run_updater
+        run: |
+          # Setting up Git user
+          git config --global user.name 'yunohost-bot'
+          git config --global user.email 'yunohost-bot@users.noreply.github.com'
+          # Run the updater script
+          /bin/bash .github/workflows/updater.sh
+      - name: Commit changes
+        id: commit
+        if: ${{ env.PROCEED == 'true' }}
+        run: |
+          git commit -am "Upgrade to v$VERSION"
+      - name: Create Pull Request
+        id: cpr
+        if: ${{ env.PROCEED == 'true' }}
+        uses: peter-evans/create-pull-request@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: Update to version ${{ env.VERSION }}
+          committer: 'yunohost-bot <yunohost-bot@users.noreply.github.com>'
+          author: 'yunohost-bot <yunohost-bot@users.noreply.github.com>'
+          signoff: false
+          base: testing
+          branch: ci-auto-update-v${{ env.VERSION }}
+          delete-branch: true
+          title: 'Upgrade to version ${{ env.VERSION }}'
+          body: |
+            Upgrade to v${{ env.VERSION }}
+          draft: false

conf/amd64.src

@@ -0,0 +1,6 @@
+SOURCE_URL=https://packages.gitlab.com/runner/gitlab-runner/packages/debian/buster/gitlab-runner_15.0.0_amd64.deb/download.deb
+SOURCE_SUM=0cdf0505fe72d46472f685736ace64fc5b5c7181fcb374d77b04e629bb6eeba5
+SOURCE_SUM_PRG=sha256sum
+SOURCE_FILENAME=gitlab-runner.deb
+SOURCE_EXTRACT=false
+SOURCE_FORMAT=deb

conf/arm.src.default

@@ -1,6 +0,0 @@
-SOURCE_URL=https://packages.gitlab.com/runner/gitlab-runner/packages/debian/buster/gitlab-runner___VERSION___armhf.deb/download.deb
-SOURCE_SUM=__SHA256_SUM__
-SOURCE_SUM_PRG=sha256sum
-SOURCE_FILENAME=__SOURCE_FILENAME__
-SOURCE_EXTRACT=false
-SOURCE_FORMAT=deb

conf/armhf.src

@@ -0,0 +1,6 @@
+SOURCE_URL=https://packages.gitlab.com/runner/gitlab-runner/packages/debian/buster/gitlab-runner_15.0.0_armhf.deb/download.deb
+SOURCE_SUM=042ace4be975ecd916747d32e971c8356de90ef50eb2c75d372c5cd5371e2f74
+SOURCE_SUM_PRG=sha256sum
+SOURCE_FILENAME=gitlab-runner.deb
+SOURCE_EXTRACT=false
+SOURCE_FORMAT=deb

conf/i386.src

@@ -0,0 +1,6 @@
+SOURCE_URL=https://packages.gitlab.com/runner/gitlab-runner/packages/debian/buster/gitlab-runner_15.0.0_i386.deb/download.deb
+SOURCE_SUM=35bd675a1285f4ce4cd3c1494b59e0fba596ee395d9cf30c527922d969448263
+SOURCE_SUM_PRG=sha256sum
+SOURCE_FILENAME=gitlab-runner.deb
+SOURCE_EXTRACT=false
+SOURCE_FORMAT=deb

conf/i386.src.default

@@ -1,6 +0,0 @@
-SOURCE_URL=https://packages.gitlab.com/runner/gitlab-runner/packages/debian/buster/gitlab-runner___VERSION___i386.deb/download.deb
-SOURCE_SUM=__SHA256_SUM__
-SOURCE_SUM_PRG=sha256sum
-SOURCE_FILENAME=__SOURCE_FILENAME__
-SOURCE_EXTRACT=false
-SOURCE_FORMAT=deb

conf/x86-64.src.default

@@ -1,6 +0,0 @@
-SOURCE_URL=https://packages.gitlab.com/runner/gitlab-runner/packages/debian/buster/gitlab-runner___VERSION___amd64.deb/download.deb
-SOURCE_SUM=__SHA256_SUM__
-SOURCE_SUM_PRG=sha256sum
-SOURCE_FILENAME=__SOURCE_FILENAME__
-SOURCE_EXTRACT=false
-SOURCE_FORMAT=deb

scripts/actions/register

@@ -89,7 +89,7 @@ do
 		--executor "$executor" \
 		--docker-image "$docker_img" \
 		--description "Yunohost runner" \
-		--tag-list "$executor,$architecture" \
+		--tag-list "$executor,$YNH_ARCH" \
 		--run-untagged \
 		--locked="false"
 

scripts/install

@@ -37,18 +37,6 @@ ynh_script_progression --message="Validating installation parameters..."
 config_path=/etc/$app
 test ! -e "$config_path" || ynh_die "This path already contains a folder"
 
-# Detect the system architecture
-if [ -n "$(uname -m | grep 64)" ]; then
-	architecture="x86-64"
-elif [ -n "$(uname -m | grep 86)" ]; then
-	architecture="i386"
-elif [ -n "$(uname -m | grep arm)" ]; then
-	architecture="arm"
-else
-	ynh_die "Unable to detect your achitecture, please open a bug describing \
-        your hardware and the result of the command \"uname -m\"." 1
-fi
-
 # By default, the runner will use docker to run your builds. PR are welcomes to implement more executors
 executor="docker"
 
@@ -76,7 +64,6 @@ ynh_app_setting_set --app=$app --key=gitlab_url --value=$gitlab_url
 ynh_app_setting_set --app=$app --key=token --value=$token
 ynh_app_setting_set --app=$app --key=executor --value=$executor
 ynh_app_setting_set --app=$app --key=docker_image --value=$docker_image
-ynh_app_setting_set --app=$app --key=architecture --value=$architecture
 ynh_app_setting_set --app=$app --key=config_path --value=$config_path
 
 #=================================================
@@ -94,28 +81,10 @@ ynh_install_app_dependencies $pkg_dependencies
 #=================================================
 ynh_script_progression --message="Setting up source files..."
 
-update_src_version() {
-	source $YNH_APP_BASEDIR/scripts/upgrade.d/upgrade.last.sh
-	cp $YNH_APP_BASEDIR/conf/$architecture.src.default $YNH_APP_BASEDIR/conf/$architecture.src
-	ynh_replace_string --match_string="__VERSION__" --replace_string="$gitlab_runner_version" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src"
-	ynh_replace_string --match_string="__SOURCE_FILENAME__" --replace_string="$gitlab_runner_filename" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src"
-
-	if [ $architecture = "x86-64" ]; then
-		ynh_replace_string --match_string="__SHA256_SUM__" --replace_string="$gitlab_runner_x86_64_source_sha256" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src"
-	elif [ $architecture = "i386" ]; then
-		ynh_replace_string --match_string="__SHA256_SUM__" --replace_string="$gitlab_runner_i386_source_sha256" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src"
-	elif [ $architecture = "arm" ]; then
-		ynh_replace_string --match_string="__SHA256_SUM__" --replace_string="$gitlab_runner_arm_source_sha256" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src"
-	fi
-}
-
-update_src_version
-
 tempdir="$(mktemp -d)"
-
+ynh_setup_source --dest_dir=$tempdir --source_id=$YNH_ARCH
-ynh_setup_source --dest_dir=$tempdir --source_id=$architecture
+dpkg -i $tempdir/gitlab-runner.deb
-
+ynh_secure_remove --file="$tempdir"
-dpkg -i $tempdir/$gitlab_runner_filename
 
 #=================================================
 # SPECIFIC SETUP
@@ -143,7 +112,7 @@ do
 		--executor "$executor" \
 		--docker-image "$docker_img" \
 		--description "Yunohost runner" \
-		--tag-list "$executor,$architecture" \
+		--tag-list "$executor,$YNH_ARCH" \
 		--run-untagged \
 		--locked="false"
 done

scripts/restore

@@ -58,28 +58,10 @@ ynh_install_app_dependencies $pkg_dependencies
 #=================================================
 ynh_script_progression --message="Reinstalling GitLab Runner..."
 
-update_src_version() {
-	source $YNH_APP_BASEDIR/scripts/upgrade.d/upgrade.last.sh
-	cp $YNH_APP_BASEDIR/conf/$architecture.src.default $YNH_APP_BASEDIR/conf/$architecture.src
-	ynh_replace_string --match_string="__VERSION__" --replace_string="$gitlab_runner_version" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src"
-	ynh_replace_string --match_string="__SOURCE_FILENAME__" --replace_string="$gitlab_runner_filename" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src"
-
-	if [ $architecture = "x86-64" ]; then
-		ynh_replace_string --match_string="__SHA256_SUM__" --replace_string="$gitlab_runner_x86_64_source_sha256" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src"
-	elif [ $architecture = "i386" ]; then
-		ynh_replace_string --match_string="__SHA256_SUM__" --replace_string="$gitlab_runner_i386_source_sha256" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src"
-	elif [ $architecture = "arm" ]; then
-		ynh_replace_string --match_string="__SHA256_SUM__" --replace_string="$gitlab_runner_arm_source_sha256" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src"
-	fi
-}
-
-update_src_version
-
 tempdir="$(mktemp -d)"
-
+ynh_setup_source --dest_dir=$tempdir --source_id=$YNH_ARCH
-ynh_setup_source --dest_dir=$tempdir --source_id=$architecture
+dpkg -i $tempdir/gitlab-runner.deb
-
+ynh_secure_remove --file="$tempdir"
-dpkg -i $tempdir/$gitlab_runner_filename
 
 #=================================================
 # SPECIFIC SETUP
@@ -107,7 +89,7 @@ do
 		--executor "$executor" \
 		--docker-image "$docker_img" \
 		--description "Yunohost runner" \
-		--tag-list "$executor,$architecture" \
+		--tag-list "$executor,$YNH_ARCH" \
 		--run-untagged \
 		--locked="false"
 done

scripts/upgrade

@@ -46,41 +46,29 @@ ynh_abort_if_errors
 #=================================================
 ynh_script_progression --message="Ensuring downward compatibility..."
 
-# NOTING TO DO HERE YET
+ynh_app_setting_delete --app=$app --key=architecture
 
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
 ynh_script_progression --message="Upgrading source files..."
 
-update_src_version() {
+if [ "$upgrade_type" == "UPGRADE_APP" ]
-	source $YNH_APP_BASEDIR/scripts/upgrade.d/upgrade.last.sh
+then
-	cp $YNH_APP_BASEDIR/conf/$architecture.src.default $YNH_APP_BASEDIR/conf/$architecture.src
+	ynh_script_progression --message="Upgrading source files..."
-	ynh_replace_string --match_string="__VERSION__" --replace_string="$gitlab_runner_version" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src"
-	ynh_replace_string --match_string="__SOURCE_FILENAME__" --replace_string="$gitlab_runner_filename" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src"
-
-	if [ $architecture = "x86-64" ]; then
-		ynh_replace_string --match_string="__SHA256_SUM__" --replace_string="$gitlab_runner_x86_64_source_sha256" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src"
-	elif [ $architecture = "i386" ]; then
-		ynh_replace_string --match_string="__SHA256_SUM__" --replace_string="$gitlab_runner_i386_source_sha256" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src"
-	elif [ $architecture = "arm" ]; then
-		ynh_replace_string --match_string="__SHA256_SUM__" --replace_string="$gitlab_runner_arm_source_sha256" --target_file="$YNH_APP_BASEDIR/conf/$architecture.src"
-	fi
-}
-
-update_src_version
 
 	tempdir="$(mktemp -d)"
-
+	ynh_setup_source --dest_dir=$tempdir --source_id=$YNH_ARCH
-ynh_setup_source --dest_dir=$tempdir --source_id=$architecture
+	dpkg -i $tempdir/gitlab-runner.deb
-
+	ynh_secure_remove --file="$tempdir"
-dpkg -i $tempdir/$gitlab_runner_filename
+fi
 
 #=================================================
 # UPGRADE DEPENDENCIES
 #=================================================
 ynh_script_progression --message="Upgrading dependencies..."
 
+ynh_install_extra_repo --repo="https://download.docker.com/linux/debian $(lsb_release -cs) stable" --key="https://download.docker.com/linux/debian/gpg" --name="${app}-docker"
 ynh_install_app_dependencies $pkg_dependencies
 
 #=================================================

scripts/upgrade.d/upgrade.last.sh

@@ -1,9 +0,0 @@
-gitlab_runner_version="15.0.0"
-
-gitlab_runner_x86_64_source_sha256="0cdf0505fe72d46472f685736ace64fc5b5c7181fcb374d77b04e629bb6eeba5"
-
-gitlab_runner_i386_source_sha256="35bd675a1285f4ce4cd3c1494b59e0fba596ee395d9cf30c527922d969448263"
-
-gitlab_runner_arm_source_sha256="042ace4be975ecd916747d32e971c8356de90ef50eb2c75d372c5cd5371e2f74"
-
-gitlab_runner_filename="gitlab-runner-${gitlab_runner_version}.deb"