Merge pull request #32 from YunoHost-Apps/fix-n-clean

Fix and clean

.github/workflows/updater.sh

@@ -0,0 +1,114 @@
+#!/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]')
+repo=$(cat manifest.json | jq -j '.upstream.code|split("https://github.com/")[1]')
+# 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://api.github.com/repos/$repo/releases" | jq -r '.[] | select( .prerelease != true ) | .tag_name' | sort -V | tail -1)
+
+# 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
+
+asset="https://buildbot.libretro.com/stable/$version/emscripten/RetroArch.7z"
+
+# Setting up the environment variables
+echo "Current version: $current_version"
+echo "Latest release from upstream: $version"
+echo "VERSION=$version" >> $GITHUB_ENV
+echo "REPO=$repo" >> $GITHUB_ENV
+# For the time being, let's assume the script will fail
+echo "PROCEED=false" >> $GITHUB_ENV
+
+same_version=false
+# Proceed only if the retrieved version is greater or equal than the current one
+if dpkg --compare-versions "$current_version" "gt" "$version" ; then
+    echo "::warning ::Well, somehow the current version here is higher than the latest released."
+    exit 0
+elif dpkg --compare-versions "$current_version" "eq" "$version" ; then
+    echo "::notice ::No new version available, let's check if the built file has changed though..."
+    same_version=true
+# 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 ::New version available, but a branch already exists for this update."
+    exit 0
+fi
+
+#=================================================
+# UPDATE SOURCE FILES
+#=================================================
+
+# Let's download the asset and calculate its checksum
+
+# If no new version has been released, we still need to download the file again because
+# RetroArch's staff tend to silently update their build without releasing a new version...
+# Seriously, that's unsafe and not cool. 🔔
+
+# Create the temporary directory
+tempdir="$(mktemp -d)"
+
+# Download sources and calculate checksum
+filename=${asset##*/}
+curl --silent -4 -L $asset -o "$tempdir/$filename"
+checksum=$(sha256sum "$tempdir/$filename" | head -c 64)
+
+# Delete temporary directory
+rm -rf $tempdir
+
+source conf/app.src
+if [ "$checksum" == "466e1f86e2deebfc25c0bfd56f555881a80db37a22d75a3fec350ae7949f44b9" ]; then
+    echo "::error ::Uh oh, something went wrong with the downloaded file."
+    exit 1
+elif [ "$checksum" == "$SOURCE_SUM" ]; then
+    echo "::notice ::No new version available, and the built file has not changed."
+    exit 0
+elif [ "$same_version" == "true" ]; then
+    echo "::notice ::No new version available, but the built file has been silently changed upstream. 🔔"
+fi
+
+# Rewrite source file
+cat <<EOT > conf/app.src
+SOURCE_URL=$asset
+SOURCE_SUM=$checksum
+SOURCE_SUM_PRG=sha256sum
+SOURCE_FORMAT=7z
+SOURCE_FILENAME=retroarch.7z
+SOURCE_EXTRACT=false
+EOT
+echo "... conf/app.src updated"
+
+#=================================================
+# 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,50 @@
+# 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 }}
+            [See upstream release page](https://github.com/${{ env.REPO }}/releases/tag/v${{ env.VERSION }})
+          draft: false

conf/app.src

@@ -0,0 +1,6 @@
+SOURCE_URL=https://buildbot.libretro.com/stable/1.10.3/emscripten/RetroArch.7z
+SOURCE_SUM=ccbed86baa1b7f6a92104c20ca9671124c15189dfddf76be641c7486c74fc1d2
+SOURCE_SUM_PRG=sha256sum
+SOURCE_FORMAT=7z
+SOURCE_FILENAME=retroarch.7z
+SOURCE_EXTRACT=false

conf/app.src.default

@@ -1,5 +0,0 @@
-SOURCE_URL=https://buildbot.libretro.com/stable/__UPSTREAM_VERSION__/emscripten/RetroArch.7z
-SOURCE_SUM=a87c96995c9784485ea0686bcc5a37d334cf2e6a56106a80dc447bbfad9ffc98
-SOURCE_SUM_PRG=sha256sum
-SOURCE_FORMAT=7z
-SOURCE_EXTRACT=false

scripts/backup

@@ -14,10 +14,6 @@ source /usr/share/yunohost/helpers
 # MANAGE SCRIPT FAILURE
 #=================================================
 
-ynh_clean_setup () {
-	### Remove this function if there's nothing to clean before calling the remove script.
-	true
-}
 # Exit if an error occurs during the execution of the script
 ynh_abort_if_errors
 

scripts/install

@@ -13,10 +13,6 @@ source /usr/share/yunohost/helpers
 # MANAGE SCRIPT FAILURE
 #=================================================
 
-ynh_clean_setup () {
-	### Remove this function if there's nothing to clean before calling the remove script.
-	true
-}
 # Exit if an error occurs during the execution of the script
 ynh_abort_if_errors
 
@@ -28,7 +24,6 @@ domain=$YNH_APP_ARG_DOMAIN
 path_url=$YNH_APP_ARG_PATH
 is_public=$YNH_APP_ARG_IS_PUBLIC
 app=$YNH_APP_INSTANCE_NAME
-upstream_version=$(ynh_app_upstream_version)
 
 #=================================================
 # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
@@ -68,8 +63,7 @@ ynh_script_progression --message="Setting up source files..." --weight=60
 ynh_app_setting_set --app=$app --key=final_path --value=$final_path
 # Download, check integrity, uncompress and patch the source from app.src
 # uncompress and patch done manually as 7z format is not supported
-ynh_add_config --template="../conf/app.src.default" --destination="../conf/retroarch.src"
+ynh_setup_source --dest_dir="$final_path"
-ynh_setup_source --dest_dir="$final_path" --source_id=$app
 #7z archive not handled by ynh and no way to strip component, have to move it manually
 7zr x $final_path/retroarch.7z -o$final_path
 mv $final_path/retroarch/* $final_path/

scripts/restore

@@ -14,10 +14,6 @@ source /usr/share/yunohost/helpers
 # MANAGE SCRIPT FAILURE
 #=================================================
 
-ynh_clean_setup () {
-	#### Remove this function if there's nothing to clean before calling the remove script.
-	true
-}
 # Exit if an error occurs during the execution of the script
 ynh_abort_if_errors
 

scripts/upgrade

@@ -15,7 +15,6 @@ source /usr/share/yunohost/helpers
 ynh_script_progression --message="Loading installation settings..." --weight=1
 
 app=$YNH_APP_INSTANCE_NAME
-upstream_version=$(ynh_app_upstream_version)
 
 domain=$(ynh_app_setting_get --app=$app --key=domain)
 path_url=$(ynh_app_setting_get --app=$app --key=path)
@@ -52,8 +51,7 @@ then
 	ynh_script_progression --message="Upgrading source files..." --weight=5
 
 	# Download, check integrity, uncompress and patch the source from app.src
-	ynh_add_config --template="../conf/app.src.default" --destination="../conf/retroarch.src"
+	ynh_setup_source --dest_dir="$final_path"
-	ynh_setup_source --dest_dir="$final_path" --source_id=$app
 	#7z archive not handled by ynh and no way to strip component, have to move it manually
 	7zr x $final_path/retroarch.7z -o$final_path
 	#mv not working as target directory is not empty