Merge pull request #47 from YunoHost-Apps/testing

Testing

.github/workflows/updater.sh

@@ -0,0 +1,130 @@
+#!/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.
+
+# Remove this exit command when you are ready to run this Action
+#exit 1
+
+#=================================================
+# 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
+# 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
+  "v"*".tar.gz")
+    src="app"
+    ;;
+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=tar.gz
+SOURCE_IN_SUBDIR=true
+SOURCE_EXTRACT=true
+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

README.md

@@ -1,3 +1,8 @@
+<!--
+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.
+-->
+
 # Leed for YunoHost
 
 [![Integration level](https://dash.yunohost.org/integration/leed.svg)](https://dash.yunohost.org/appci/app/leed) ![](https://ci-apps.yunohost.org/ci/badges/leed.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/leed.maintain.svg)  
@@ -5,59 +10,32 @@
 
 *[Lire ce readme en français.](./README_fr.md)*
 
-> *This package allow you to install Leed quickly and simply on a YunoHost server.  
+> *This package allows you to install Leed quickly and simply on a YunoHost server.
-If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
+If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
 
 ## Overview
+
 Leed (short for Light Feed) is a minimalist RSS/ATOM aggregator which offers fast RSS consultation and non-intrusive features.
 
-**Shipped version:** 1.9.0
+
+**Shipped version:** 1.9.0~ynh2
+
+
 
 ## Screenshots
 
-![](http://projet.idleman.fr/leed/data/leed1.jpg)
+![](./doc/screenshots/leed1.jpg)
 
-## Demo
+## Documentation and resources
 
-No demo available.
+* Official app website: http://leed.idleman.fr/
+* Upstream app code repository: http://git.idleman.fr/LeedRSS/Leed
+* YunoHost documentation for this app: https://yunohost.org/app_leed
+* Report a bug: https://github.com/YunoHost-Apps/leed_ynh/issues
 
-## Configuration
+## Developer info
 
-Use the admin panel of your Leed to configure this app.
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/leed_ynh/tree/testing).
-
-## Documentation
-
-* YunoHost documentation: There no other documentations, feel free to contribute.
-
-## YunoHost specific features
-
-* Login secured by Fail2Ban
-
-#### Multi-users support
-
-Not supported.
-
-#### Supported architectures
-
-* x86-64 - [![](https://ci-apps.yunohost.org/ci/logs/leed%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/leed/)
-* ARMv8-A - [![](https://ci-apps-arm.yunohost.org/ci/logs/leed%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/leed/)
-
-## Limitations
-
-## Additionnal informations
-
-## Links
-
- * Report a bug: https://github.com/YunoHost-Apps/leed_ynh/issues
- * Leed website: http://leed.idleman.fr/
- * Leed repository: http://git.idleman.fr/LeedRSS/Leed
- * YunoHost website: https://yunohost.org/
-
----
-
-## Developers infos
-
-Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/leed_ynh/tree/testing).
 
 To try the testing branch, please proceed like that.
 ```
@@ -65,3 +43,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/leed_ynh/tree/testing
 or
 sudo yunohost app upgrade leed -u https://github.com/YunoHost-Apps/leed_ynh/tree/testing --debug
 ```
+
+**More info regarding app packaging:** https://yunohost.org/packaging_apps

README_fr.md

@@ -4,62 +4,39 @@
 [![Installer Leed avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=leed)
 
 *[Read this readme in english.](./README.md)*
+*[Lire ce readme en français.](./README_fr.md)*
 
-> *Ce package vous permet d'installer Leed rapidement et simplement sur un serveur YunoHost.  
+> *Ce package vous permet d'installer Leed rapidement et simplement sur un serveur YunoHost.
-Si vous n'avez pas YunoHost, merci de regarder [ici](https://yunohost.org/#/install_fr) pour savoir comment l'installer et en profiter.*
+Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
+
+## Vue d'ensemble
 
-## Résumé
 Leed (contraction de Light Feed) est un agrégateur RSS/ATOM minimaliste qui permet la consultation de flux RSS de manière rapide et non intrusive.
 
-**Version embarquée :** 1.9.0
+**Version incluse :** 1.9.0~ynh2
+
+
 
 ## Captures d'écran
 
-![](http://projet.idleman.fr/leed/data/leed1.jpg)
+![](./doc/screenshots/leed1.jpg)
 
-## Démo
+## Documentations et ressources
 
-Aucune démo pour cette application.
+* Site officiel de l'app : http://leed.idleman.fr/
+* Dépôt de code officiel de l'app : http://git.idleman.fr/LeedRSS/Leed
+* Documentation YunoHost pour cette app : https://yunohost.org/app_leed
+* Signaler un bug : https://github.com/YunoHost-Apps/leed_ynh/issues
 
-## Configuration
+## Informations pour les développeurs
-
-Utiliser le panneau d'administration de votre Leed pour configurer cette application.
-
-## Documentation
-
- * Documentation YunoHost : Il n'y a pas d'autre documentation, n'hésitez pas à contribuer.
-
-## Fonctionnalités spécifiques à YunoHost
-
-* Login sécurisé par Fail2Ban
-
-#### Support multi-utilisateurs
-
-Non supportée.
-
-#### Architectures supportées.
-
-* x86-64 - [![](https://ci-apps.yunohost.org/ci/logs/leed%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/leed/)
-* ARMv8-A - [![](https://ci-apps-arm.yunohost.org/ci/logs/leed%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/leed/)
-
-## Informations additionnelles
-
-## Liens
-
- * Reporter un bug : https://github.com/YunoHost-Apps/leed_ynh/issues
- * Site de Leed : http://leed.idleman.fr/
- * Dépôt de Leed : http://git.idleman.fr/LeedRSS/Leed
- * Site de YunoHost : https://yunohost.org/
-
----
-
-## Informations à l'intention des développeurs
 
 Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/leed_ynh/tree/testing).
 
-Pour tester la branche testing, merci de procéder ainsi.
+Pour essayer la branche testing, procédez comme suit.
 ```
 sudo yunohost app install https://github.com/YunoHost-Apps/leed_ynh/tree/testing --debug
 ou
 sudo yunohost app upgrade leed -u https://github.com/YunoHost-Apps/leed_ynh/tree/testing --debug
 ```
+
+**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps

check_process

@@ -33,7 +33,7 @@
 		port_already_use=0
 		change_url=1
         actions=0
-        config_panel=1
+        config_panel=0
 ;;; Options
 Email=
 Notification=change

conf/nginx.conf

@@ -4,11 +4,6 @@ location __PATH__/ {
   # Path to source
   alias __FINALPATH__/ ;
 
-  # Force usage of https
-  if ($scheme = http) {
-    rewrite ^ https://$server_name$request_uri? permanent;
-  }
-
   index index.php;
 
   try_files $uri $uri/ index.php;

config_panel.toml

@@ -1,4 +1,4 @@
-version = "0.1"
+version = "1.0"
 name = "Leed configuration panel"
 
 [main]

doc/DESCRIPTION.md

@@ -0,0 +1 @@
+Leed (short for Light Feed) is a minimalist RSS/ATOM aggregator which offers fast RSS consultation and non-intrusive features.

doc/DESCRIPTION_fr.md

@@ -0,0 +1 @@
+Leed (contraction de Light Feed) est un agrégateur RSS/ATOM minimaliste qui permet la consultation de flux RSS de manière rapide et non intrusive.

manifest.json

@@ -6,8 +6,13 @@
 		"en": "Minimalistic RSS feed aggregator which allows quick and non-intrusive reading of feeds",
 		"fr": "Agrégateur RSS minimaliste qui permet la consultation de flux RSS de manière rapide et non intrusive"
 	},
-	"version": "1.9.0~ynh1",
+	"version": "1.9.0~ynh2",
 	"url": "http://leed.idleman.fr/",
+	 "upstream": {
+        "license": "AGPL-3.0",
+        "website": "http://leed.idleman.fr/",
+        "code": "http://git.idleman.fr/LeedRSS/Leed"
+    },
 	"license": "AGPL-3.0",
 	"maintainer": {
 		"name": "",
@@ -18,7 +23,7 @@
 		"email": "maniackc_dev@crudelis.fr"
 	}],
 	"requirements": {
-		"yunohost": ">= 4.2.4"
+		"yunohost": ">= 4.3.0"
 	},
 	"multi_instance": true,
 	"services": [

scripts/install

@@ -45,7 +45,6 @@ ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url
 #=================================================
 ynh_script_progression --message="Storing installation settings..." --weight=2
 
-
 ynh_app_setting_set --app=$app --key=domain --value=$domain
 ynh_app_setting_set --app=$app --key=path --value=$path_url
 ynh_app_setting_set --app=$app --key=admin --value=$admin

scripts/restore

@@ -37,8 +37,7 @@ admin=$(ynh_app_setting_get --app=$app --key=admin)
 #=================================================
 ynh_script_progression --message="Validating restoration parameters..."
 
-test ! -d $final_path \
+test ! -d $final_path || ynh_die --message="There is already a directory: $final_path "
-	|| ynh_die --message="There is already a directory: $final_path "
 
 #=================================================
 # ACTIVATE MAINTENANCE MODE

scripts/upgrade

@@ -19,10 +19,10 @@ app=$YNH_APP_INSTANCE_NAME
 domain=$(ynh_app_setting_get --app=$app --key=domain)
 path_url=$(ynh_app_setting_get --app=$app --key=path)
 admin=$(ynh_app_setting_get --app=$app --key=admin)
-is_public=$(ynh_app_setting_get --app=$app --key=is_public)
 final_path=$(ynh_app_setting_get --app=$app --key=final_path)
 db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd)
 db_name=$(ynh_app_setting_get --app=$app --key=db_name)
+is_public=$(ynh_app_setting_get --app=$app --key=is_public)
 
 overwrite_nginx=$(ynh_app_setting_get --app=$app --key=overwrite_nginx)
 overwrite_phpfpm=$(ynh_app_setting_get --app=$app --key=overwrite_phpfpm)
@@ -35,7 +35,6 @@ phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
 #=================================================
 # CHECK VERSION
 #=================================================
-ynh_script_progression --message="Checking version..."
 
 upgrade_type=$(ynh_check_app_version_changed)
 
@@ -202,7 +201,11 @@ then
     ynh_permission_update --permission="main" --add="visitors"
     # Start the upgrade procedure of leed.
     ynh_local_curl "/"
-    ynh_permission_update --permission="main" --remove="visitors"
+    # Make app public if necessary
+    if [ $is_public -eq 0 ]
+    then
+        ynh_permission_update --permission="main" --remove="visitors"
+    fi
 fi
 
 #=================================================
@@ -215,17 +218,6 @@ ynh_script_progression --message="Reconfiguring Fail2Ban..." --weight=8
 # Create a dedicated Fail2Ban config
 ynh_add_fail2ban_config --logpath="/var/log/nginx/${domain}-error.log" --failregex="PHP message: Leed: wrong login for .* client: <HOST>" --max_retry=5
 
-#=================================================
-# SETUP SSOWAT
-#=================================================
-ynh_script_progression --message="Configuring permissions..." --weight=1
-
-# Make app public if necessary
-if [ $is_public -eq 1 ]
-then
-    ynh_permission_update --permission="main" --add="visitors"
-fi
-
 #=================================================
 # RELOAD NGINX
 #=================================================