Merge pull request #218 from YunoHost-Apps/cleaning

cleaning

.github/workflows/updater.sh

@@ -1,114 +0,0 @@
-#!/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.toml | tomlq -r '.version|split("~")[0]')
-current_project_version=$(grep -Po 'project_version="\K[^"]*' scripts/_common.sh)
-core_repo=$(cat manifest.toml | tomlq -r '.upstream.code|split("https://github.com/")[1]')
-project_repo="flarum/flarum"
-# Some jq magic is needed, because the latest upstream release is not always the latest version (e.g. security patches for older versions)
-# Core version may be higher than project version, and we actually download the project then perform Composer install.
-version=$(curl --silent "https://api.github.com/repos/$core_repo/releases" | jq -r '.[] | select( .prerelease != true ) | .tag_name' | sort -V | tail -1)
-project_version=$(curl --silent "https://api.github.com/repos/$project_repo/releases" | jq -r '.[] | select(.tag_name<="'$version'") | .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
-if [[ ${current_project_version:0:1} == "v" || ${current_project_version:0:1} == "V" || ${current_project_version:0:1} == "~" ]]; then
-    current_project_version=${current_project_version:1}
-fi
-if [[ ${project_version:0:1} == "v" || ${project_version:0:1} == "V" || ${project_version:0:1} == "~" ]]; then
-    project_version=${project_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
-
-#=================================================
-# UPDATE SOURCE FILES
-#=================================================
-
-# Proceed only if the retrieved version is greater than the current one
-if dpkg --compare-versions "$current_project_version" "lt" "$project_version" ; then
-
-# Beware, the "v" is back here
-asset_url="https://github.com/flarum/flarum/archive/v${project_version}.zip"
-src="app"
-extension="zip"
-
-# 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
-
-# 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=true
-EOT
-echo "conf/$src.src updated"
-
-else
-
-echo "No need to update conf/$src.src"
-
-fi
-
-#=================================================
-# SPECIFIC UPDATE STEPS
-#=================================================
-
-sed -i "/project_version=/c\project_version=\"$project_version\"" scripts/_common.sh
-echo "scripts/_common.sh patched"
-
-#=================================================
-# GENERIC FINALIZATION
-#=================================================
-
-# Replace new version in manifest
-sed -i "/version =/c\version = \"$version~ynh1\"" manifest.toml
-
-# 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

@@ -1,51 +0,0 @@
-# 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@v3
-        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'
-          # Download yq/tomlq
-          pip install yq
-          # 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@v4
-        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
-          branch: ci-auto-update-v${{ env.VERSION }}
-          base: testing
-          delete-branch: true
-          title: 'Upgrade to version ${{ env.VERSION }}'
-          body: |
-            Upgrade to v${{ env.VERSION }}
-          draft: false

conf/app.src

@@ -1,5 +0,0 @@
-SOURCE_URL=https://github.com/flarum/flarum/archive/v1.8.0.zip
-SOURCE_SUM=c6179876c27689522eb3e46d369ca053517602f528dcd36ba8a338ec768845cd
-SOURCE_SUM_PRG=sha256sum
-SOURCE_FORMAT=zip
-SOURCE_IN_SUBDIR=true

manifest.toml

@@ -20,7 +20,7 @@ cpe = "cpe:2.3:a:flarum:flarum"
 fund = "https://flarum.org/donate/"
 
 [integration]
-yunohost = ">= 11.0"
+yunohost = ">= 11.2"
 architectures = "all"
 multi_instance = true
 ldap = true
@@ -55,8 +55,8 @@ ram.runtime = "50M"
     default = "My forum"
 
     [install.init_main_permission]
-    help.en = "If public, it will be open to all visitors like any forum. If private, only the YunoHost server users can access it."
+    help.en = "If set to 'visitors', it will be open to all visitors like any forum. If private, only the YunoHost server users can access it."
-    help.fr = "Si public, le forum sera accessible à tous, comme pour tout forum. Si privé, seuls les utilisateurs du serveur YunoHost pourront y accéder."
+    help.fr = "Si défini sur 'visiteurs', le forum sera accessible à tous, comme pour tout forum. Si privé, seuls les utilisateurs du serveur YunoHost pourront y accéder."
     type = "group"
     default = "visitors"
 
@@ -64,11 +64,17 @@ ram.runtime = "50M"
     ask.en = "Choose the application language"
     ask.fr = "Choisissez la langue de l'application"
     ask.de = "Wählen Sie eine Sprache"
-    type = "string"
+    type = "select"
     choices = ["fr", "en", "de"]
     default = "en"
 
 [resources]
+
+        [resources.sources.main]
+        url = "https://github.com/flarum/flarum/archive/v1.8.0.zip"
+        sha256 = "c6179876c27689522eb3e46d369ca053517602f528dcd36ba8a338ec768845cd"
+        autoupdate.strategy = "latest_github_tag"
+
     [resources.system_user]
 
     [resources.install_dir]
@@ -77,7 +83,7 @@ ram.runtime = "50M"
     main.url = "/"
 
     [resources.apt]
-    packages = "mariadb-server, php8.0, php8.0-curl, php8.0-dom, php8.0-gd, php8.0-json, php8.0-mbstring, php8.0-pdo-mysql, php8.0-tokenizer, php8.0-zip, php8.0-ldap"
+    packages = "mariadb-server, php8.2-curl, php8.2-dom, php8.2-gd, php8.2-mbstring, php8.2-pdo-mysql, php8.2-tokenizer, php8.2-zip, php8.2-ldap"
 
     [resources.database]
     type = "mysql"

scripts/install

@@ -38,26 +38,23 @@ ynh_script_progression --message="Setting up source files..." --weight=3
 # Download, check integrity, uncompress and patch the source from app.src
 ynh_setup_source --dest_dir="$install_dir"
 
-chmod 750 "$install_dir"
 chmod -R o-rwx "$install_dir"
 chown -R $app:www-data "$install_dir"
 
 #=================================================
-# PHP-FPM CONFIGURATION
+# SYSTEM CONFIGURATION
 #=================================================
-ynh_script_progression --message="Configuring PHP-FPM..."
+ynh_script_progression --message="Adding system configurations related to $app..." --weight=1
 
 # Create a dedicated PHP-FPM config
-ynh_add_fpm_config --usage=low --footprint=low
+ynh_add_fpm_config
-
-#=================================================
-# NGINX CONFIGURATION
-#=================================================
-ynh_script_progression --message="Configuring NGINX web server..."
 
 # Create a dedicated NGINX config
 ynh_add_nginx_config
 
+# Use logrotate to manage application logfile(s)
+ynh_use_logrotate
+
 #=================================================
 # SPECIFIC SETUP
 #=================================================
@@ -133,16 +130,6 @@ chmod 750 "$install_dir"
 chmod -R o-rwx "$install_dir"
 chown -R $app:www-data "$install_dir"
 
-#=================================================
-# GENERIC FINALIZATION
-#=================================================
-# SETUP LOGROTATE
-#=================================================
-ynh_script_progression --message="Configuring log rotation..."
-
-# Use logrotate to manage application logfile(s)
-ynh_use_logrotate
-
 #=================================================
 # END OF SCRIPT
 #=================================================

scripts/remove

@@ -11,33 +11,18 @@ source experimental_helpers/ynh_add_swap
 source /usr/share/yunohost/helpers
 
 #=================================================
-# REMOVE NGINX CONFIGURATION
+# REMOVE SYSTEM CONFIGURATIONS
 #=================================================
-ynh_script_progression --message="Removing NGINX web server configuration..." --weight=1
+# REMOVE SYSTEMD SERVICE 
+#=================================================
+ynh_script_progression --message="Removing system configurations related to $app..." --weight=1
 
 ynh_remove_nginx_config
 
-#=================================================
-# REMOVE PHP-FPM CONFIGURATION
-#=================================================
-ynh_script_progression --message="Removing PHP-FPM configuration..." --weight=1
-
 ynh_remove_fpm_config
 
-#=================================================
-# REMOVE LOGROTATE CONFIGURATION
-#=================================================
-ynh_script_progression --message="Removing logrotate configuration..." --weight=1
-
 ynh_remove_logrotate
 
-#=================================================
-# SPECIFIC REMOVE
-#=================================================
-# REMOVE SWAP
-#===================================================
-ynh_script_progression --message="Removing swap..." --weight=1
-
 ynh_del_swap
 
 #=================================================

scripts/restore

@@ -20,29 +20,9 @@ ynh_script_progression --message="Restoring the app main directory..." --weight=
 
 ynh_restore_file --origin_path="$install_dir"
 
-chmod 750 "$install_dir"
 chmod -R o-rwx "$install_dir"
 chown -R $app:www-data "$install_dir"
 
-#=================================================
-# SPECIFIC RESTORATION
-#=================================================
-# RESTORE THE PHP-FPM CONFIGURATION
-#=================================================
-ynh_script_progression --message="Restoring the PHP-FPM configuration..."
-
-ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf"
-
-# Recreate a dedicated php-fpm config
-ynh_add_fpm_config --usage=low --footprint=low
-
-#=================================================
-# RESTORE THE NGINX CONFIGURATION
-#=================================================
-ynh_script_progression --message="Restoring the NGINX configuration..."
-
-ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
-
 #=================================================
 # RESTORE THE MYSQL DATABASE
 #=================================================
@@ -50,6 +30,19 @@ ynh_script_progression --message="Restoring the MySQL database..."
 
 ynh_mysql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./db.sql
 
+#=================================================
+# RESTORE SYSTEM CONFIGURATIONS
+#=================================================
+# RESTORE THE PHP-FPM CONFIGURATION
+#=================================================
+ynh_script_progression --message="Restoring system configurations related to $app..." --weight=1
+
+ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf"
+
+ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
+
+ynh_restore_file --origin_path="/etc/logrotate.d/$app"
+
 #=================================================
 # ADD SWAP
 #=================================================
@@ -59,13 +52,6 @@ if [ ${PACKAGE_CHECK_EXEC:-0} -eq 0 ]; then
   ynh_add_swap --size=$swap_needed
 fi
 
-#=================================================
-# RESTORE THE LOGROTATE CONFIGURATION
-#=================================================
-ynh_script_progression --message="Restoring the logrotate configuration..."
-
-ynh_restore_file --origin_path="/etc/logrotate.d/$app"
-
 #=================================================
 # GENERIC FINALIZATION
 #=================================================

scripts/upgrade

@@ -88,12 +88,7 @@ chown -R $app:www-data "$install_dir"
 ynh_script_progression --message="Upgrading php-fpm configuration..." --weight=1
 
 # Create a dedicated php-fpm config
-ynh_add_fpm_config --usage=low --footprint=low
+ynh_add_fpm_config
-
-#=================================================
-# NGINX CONFIGURATION
-#=================================================
-ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=1
 
 # Create a dedicated NGINX config
 ynh_add_nginx_config
@@ -120,9 +115,6 @@ then
 	# Set right permissions
 	chown -R $app:www-data $install_dir
 
-	# Install Composer and Flarum
-	ynh_exec_warn_less ynh_install_composer --phpversion=$phpversion --workdir=$install_dir
-
 	if ynh_compare_current_package_version --comparison lt --version 1.1.0~ynh1
 	then
 		# Starting 1.0 (implemented for 1.1 in the package), version requirement is "*" for extensions

tests.toml

@@ -5,4 +5,5 @@ test_format = 1.0
     args.password = "Passw0rd!"
     args.language = "fr"
 
-    test_upgrade_from.e2784eb0fbef9109f074f1b158ed4a8b46e261c3.name = "Upgrade from 1.4.0"
+    test_upgrade_from.e2784eb0fbef9109f074f1b158ed4a8b46e261c3.name = "Upgrade from 1.4.0~ynh1"
+    test_upgrade_from.a10de288c1846116fa18d3261be39e089175eceb.name = "Upgrade from 1.8.1~ynh1"