Merge pull request #24 from YunoHost-Apps/upgrade

Upgrade
2024-09-03 20:36:08 +02:00 · 2022-07-06 17:39:58 +02:00 · 2022-07-06 17:39:58 +02:00 · c0645350ee
commit c0645350ee
parent d45a727ca1 f9aa04de36
12 changed files with 274 additions and 53 deletions
--- a/.github/workflows/updater.sh
+++ b/.github/workflows/updater.sh
@ -0,0 +1,132 @@
+#!/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)
+assets=($(curl --silent "https://api.github.com/repos/$repo/releases" | jq -r '[ .[] | select(.tag_name=="'$version'").assets[].browser_download_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
+echo "REPO=$repo" >> $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
+  *"deb"*)
+    src="app"
+    ;;
+  *)
+    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=deb
+SOURCE_IN_SUBDIR=false
+SOURCE_FILENAME=webmin.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
--- a/.github/workflows/updater.yml
+++ b/.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
--- a/README.md
+++ b/README.md
@ -5,7 +5,7 @@ It shall NOT be edited by hand.

 # Webmin for YunoHost

-[![Integration level](https://dash.yunohost.org/integration/webmin.svg)](https://dash.yunohost.org/appci/app/webmin) ![](https://ci-apps.yunohost.org/ci/badges/webmin.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/webmin.maintain.svg)  
+[![Integration level](https://dash.yunohost.org/integration/webmin.svg)](https://dash.yunohost.org/appci/app/webmin) ![Working status](https://ci-apps.yunohost.org/ci/badges/webmin.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/webmin.maintain.svg)  
 [![Install Webmin with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=webmin)

 *[Lire ce readme en français.](./README_fr.md)*
@ -19,35 +19,34 @@ Webmin is a web-based interface for system administration for Unix. Using any mo

 **Shipped version:** 1.984~ynh1

-
-
 ## Screenshots

-![](./doc/screenshots/screenshot1.gif)
+![Screenshot of Webmin](./doc/screenshots/screenshot1.gif)

 ## Disclaimers / important information

 * This app has **root** access which can change core things in the system, thus **breaking the YunoHost**. Use it carefully and read the [documents](https://doxfer.webmin.com/Webmin/Main_Page) two times before changing values.
-* Only **root** (system user) can connect 
+* Only **user** given permission at time of the installation can **access** the Webmin login interface
+* To login to webmin, use root and root password 
 * Webmin will **update itself** when system updates are run. So no need to **run upgrade script** once installed.
-* Only **user** given permission at time of the installation can **access** the Webmin 

 ## Documentation and resources

-* Official app website: http://www.webmin.com
-* Upstream app code repository: https://github.com/webmin/webmin
-* YunoHost documentation for this app: https://yunohost.org/app_webmin
-* Report a bug: https://github.com/YunoHost-Apps/webmin_ynh/issues
+* Official app website: <http://www.webmin.com>
+* Upstream app code repository: <https://github.com/webmin/webmin>
+* YunoHost documentation for this app: <https://yunohost.org/app_webmin>
+* Report a bug: <https://github.com/YunoHost-Apps/webmin_ynh/issues>

 ## Developer info

 Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/webmin_ynh/tree/testing).

 To try the testing branch, please proceed like that.
-```
+
+``` bash
 sudo yunohost app install https://github.com/YunoHost-Apps/webmin_ynh/tree/testing --debug
 or
 sudo yunohost app upgrade webmin -u https://github.com/YunoHost-Apps/webmin_ynh/tree/testing --debug
 ```

-**More info regarding app packaging:** https://yunohost.org/packaging_apps
+**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
--- a/README_fr.md
+++ b/README_fr.md
@ -1,10 +1,14 @@
+<!--
+N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
+It shall NOT be edited by hand.
+-->
+
 # Webmin pour YunoHost

-[![Niveau d'intégration](https://dash.yunohost.org/integration/webmin.svg)](https://dash.yunohost.org/appci/app/webmin) ![](https://ci-apps.yunohost.org/ci/badges/webmin.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/webmin.maintain.svg)  
+[![Niveau d'intégration](https://dash.yunohost.org/integration/webmin.svg)](https://dash.yunohost.org/appci/app/webmin) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/webmin.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/webmin.maintain.svg)  
 [![Installer Webmin avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=webmin)

 *[Read this readme in english.](./README.md)*
-*[Lire ce readme en français.](./README_fr.md)*

 > *Ce package vous permet d'installer Webmin rapidement et simplement sur un serveur YunoHost.
 Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
@ -15,35 +19,34 @@ Webmin is a web-based interface for system administration for Unix. Using any mo

 **Version incluse :** 1.984~ynh1

-
-
 ## Captures d'écran

-![](./doc/screenshots/screenshot1.gif)
+![Capture d'écran de Webmin](./doc/screenshots/screenshot1.gif)

 ## Avertissements / informations importantes

 * This app has **root** access which can change core things in the system, thus **breaking the YunoHost**. Use it carefully and read the [documents](https://doxfer.webmin.com/Webmin/Main_Page) two times before changing values.
-* Only **root** (system user) can connect 
+* Only **user** given permission at time of the installation can **access** the Webmin login interface
+* To login to webmin, use root and root password 
 * Webmin will **update itself** when system updates are run. So no need to **run upgrade script** once installed.
-* Only **user** given permission at time of the installation can **access** the Webmin 

 ## Documentations et ressources

-* Site officiel de l'app : http://www.webmin.com
-* Dépôt de code officiel de l'app : https://github.com/webmin/webmin
-* Documentation YunoHost pour cette app : https://yunohost.org/app_webmin
-* Signaler un bug : https://github.com/YunoHost-Apps/webmin_ynh/issues
+* Site officiel de l'app : <http://www.webmin.com>
+* Dépôt de code officiel de l'app : <https://github.com/webmin/webmin>
+* Documentation YunoHost pour cette app : <https://yunohost.org/app_webmin>
+* Signaler un bug : <https://github.com/YunoHost-Apps/webmin_ynh/issues>

 ## Informations pour les développeurs

 Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/webmin_ynh/tree/testing).

 Pour essayer la branche testing, procédez comme suit.
-```
+
+``` bash
 sudo yunohost app install https://github.com/YunoHost-Apps/webmin_ynh/tree/testing --debug
 ou
 sudo yunohost app upgrade webmin -u https://github.com/YunoHost-Apps/webmin_ynh/tree/testing --debug
 ```

-**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
+**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>
--- a/4
+++ b/4
@ -22,7 +22,3 @@
 Email=
 Notification=none
 ;;; Upgrade options
-	; commit=157310ca395c326add85d24fa397f7fd0cadefb1
-		name=1.979~ynh1
-	; commit=99875e2b4c69f9ef22b05f565eeab52a8befb566
-		name=1.979~ynh2
--- a/conf/app.src
+++ b/conf/app.src
@ -0,0 +1,7 @@
+SOURCE_URL=https://github.com/webmin/webmin/releases/download/1.984/webmin_1.984_all.deb
+SOURCE_SUM=cc1e7267c945237e44762c2a8e714e271d8fafc3e8addd238ee3039ae00cb3fd
+SOURCE_SUM_PRG=sha256sum
+SOURCE_FORMAT=deb
+SOURCE_IN_SUBDIR=false
+SOURCE_FILENAME=webmin.deb
+SOURCE_EXTRACT=false
--- a/doc/DISCLAIMER.md
+++ b/doc/DISCLAIMER.md
@ -1,4 +1,4 @@
 * This app has **root** access which can change core things in the system, thus **breaking the YunoHost**. Use it carefully and read the [documents](https://doxfer.webmin.com/Webmin/Main_Page) two times before changing values.
-* Only **root** (system user) can connect 
+* Only **user** given permission at time of the installation can **access** the Webmin login interface
+* To login to webmin, use root and root password 
 * Webmin will **update itself** when system updates are run. So no need to **run upgrade script** once installed.
-* Only **user** given permission at time of the installation can **access** the Webmin 
--- a/scripts/change_url
+++ b/scripts/change_url
@ -26,10 +26,10 @@ app=$YNH_APP_INSTANCE_NAME
 #=================================================
 ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..."

-
 # Backup the current version of the app
 ynh_backup_before_upgrade
 ynh_clean_setup () {
+	ynh_clean_check_starting
 	# Remove the new domain config file, the remove script won't do it as it doesn't know yet its location.
 	ynh_secure_remove --file="/etc/nginx/conf.d/$new_domain.d/$app.conf"

--- a/scripts/install
+++ b/scripts/install
@ -14,7 +14,7 @@ source /usr/share/yunohost/helpers
 #=================================================

 ynh_clean_setup () {
-	true
+	ynh_clean_check_starting
 }
 # Exit if an error occurs during the execution of the script
 ynh_abort_if_errors
@ -57,7 +57,7 @@ ynh_app_setting_set --app=$app --key=admin --value=$admin
 ynh_script_progression --message="Finding an available port..."

 # Find an available port
-port=$(ynh_find_port --port=10000)
+port=$(ynh_find_port --port=8095)
 ynh_app_setting_set --app=$app --key=port --value=$port

 #=================================================
@ -67,8 +67,18 @@ ynh_script_progression --message="Installing dependencies..."

 ynh_install_app_dependencies $pkg_dependencies

-# Install Webmin
-ynh_install_extra_app_dependencies --repo="deb https://download.webmin.com/download/repository sarge contrib" --package="webmin" --key="https://download.webmin.com/jcameron-key.asc"
+#=================================================
+# DOWNLOAD, CHECK AND UNPACK SOURCE
+#=================================================
+ynh_script_progression --message="Setting up source files..."
+
+tempdir="$(mktemp -d)"
+# Download, check integrity, uncompress and patch the source from app.src
+ynh_setup_source --dest_dir="$tempdir"
+
+dpkg --install $tempdir/webmin.deb
+
+ynh_exec_warn_less ynh_secure_remove --file="$tempdir"

 #=================================================
 # NGINX CONFIGURATION
@ -115,7 +125,7 @@ yunohost service add $app --description="Webmin Daemon"
 ynh_script_progression --message="Starting a systemd service..."

 # Start a systemd service
-ynh_systemd_action --service_name=$app --action="start" --line_match="Started LSB" --log_path="systemd"
+ynh_systemd_action --service_name=$app --action="restart" --line_match="Started LSB" --log_path="systemd"

 #=================================================
 # SETUP SSOWAT
--- a/scripts/remove
+++ b/scripts/remove
@ -57,6 +57,7 @@ ynh_script_progression --message="Removing dependencies..."

 # Remove metapackage and its dependencies
 ynh_exec_warn_less ynh_remove_app_dependencies
+dpkg --remove $app

 #=================================================
 # GENERIC FINALIZATION
--- a/scripts/restore
+++ b/scripts/restore
@ -15,7 +15,7 @@ source /usr/share/yunohost/helpers
 #=================================================

 ynh_clean_setup () {
-	true
+	ynh_clean_check_starting
 }
 # Exit if an error occurs during the execution of the script
 ynh_abort_if_errors
@ -34,13 +34,6 @@ port=$(ynh_app_setting_get --app=$app --key=port)

 #=================================================
 # STANDARD RESTORATION STEPS
-#=================================================
-# RESTORE THE NGINX CONFIGURATION
-#=================================================
-ynh_script_progression --message="Restoring the NGINX web server configuration..."
-
-ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
-
 #=================================================
 # REINSTALL DEPENDENCIES
 #=================================================
@ -49,8 +42,25 @@ ynh_script_progression --message="Reinstalling dependencies..."
 # Define and install dependencies
 ynh_install_app_dependencies $pkg_dependencies

-# Install Webmin
-ynh_install_extra_app_dependencies --repo="deb https://download.webmin.com/download/repository sarge contrib" --package="webmin" --key="https://download.webmin.com/jcameron-key.asc"
+#=================================================
+# DOWNLOAD, CHECK AND UNPACK SOURCE
+#=================================================
+ynh_script_progression --message="Setting up source files..."
+
+tempdir="$(mktemp -d)"
+# Download, check integrity, uncompress and patch the source from app.src
+ynh_setup_source --dest_dir="$tempdir"
+
+dpkg --install $tempdir/webmin.deb
+
+ynh_exec_warn_less ynh_secure_remove --file="$tempdir"
+
+#=================================================
+# RESTORE THE NGINX CONFIGURATION
+#=================================================
+ynh_script_progression --message="Restoring the NGINX web server configuration..."
+
+ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"

 #=================================================
 # RESTORE VARIOUS FILES
@ -79,7 +89,7 @@ yunohost service add $app --description="Webmin Daemon"
 #=================================================
 ynh_script_progression --message="Starting a systemd service..."

-ynh_systemd_action --service_name=$app --action="start" --line_match="Started LSB" --log_path="systemd"
+ynh_systemd_action --service_name=$app --action="restart" --line_match="Started LSB" --log_path="systemd"

 #=================================================
 # GENERIC FINALIZATION
--- a/scripts/upgrade
+++ b/scripts/upgrade
@ -36,6 +36,7 @@ ynh_script_progression --message="Backing up the app before upgrading (may take
 # Backup the current version of the app
 ynh_backup_before_upgrade
 ynh_clean_setup () {
+	ynh_clean_check_starting
 	# Restore it if the upgrade fails
 	ynh_restore_upgradebackup
 }
@ -62,12 +63,17 @@ if ! ynh_permission_exists --permission="admin"; then
 fi

 #=================================================
-# NGINX CONFIGURATION
+# DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
-ynh_script_progression --message="Upgrading NGINX web server configuration..."
+ynh_script_progression --message="Setting up source files..."

-# Create a dedicated NGINX config
-ynh_add_nginx_config
+tempdir="$(mktemp -d)"
+# Download, check integrity, uncompress and patch the source from app.src
+ynh_setup_source --dest_dir="$tempdir"
+
+dpkg --install $tempdir/webmin.deb
+
+ynh_exec_warn_less ynh_secure_remove --file="$tempdir"

 #=================================================
 # UPGRADE DEPENDENCIES
@ -80,6 +86,14 @@ ynh_install_app_dependencies $pkg_dependencies
 ynh_backup_if_checksum_is_different --file="/etc/webmin/miniserv.conf"
 ynh_install_extra_app_dependencies --repo="deb https://download.webmin.com/download/repository sarge contrib" --package="webmin" --key="https://download.webmin.com/jcameron-key.asc"

+#=================================================
+# NGINX CONFIGURATION
+#=================================================
+ynh_script_progression --message="Upgrading NGINX web server configuration..."
+
+# Create a dedicated NGINX config
+ynh_add_nginx_config
+
 #=================================================
 # SPECIFIC UPGRADE
 #=================================================
@ -116,7 +130,7 @@ yunohost service add $app --description="Webmin Daemon"
 #=================================================
 ynh_script_progression --message="Starting a systemd service..."

-ynh_systemd_action --service_name=$app --action="start" --line_match="Started LSB" --log_path="systemd"
+ynh_systemd_action --service_name=$app --action="restart" --line_match="Started LSB" --log_path="systemd"

 #=================================================
 # RELOAD NGINX