From d1b511d9476593183496964a59b2168142b66851 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Thu, 22 Oct 2020 15:16:29 +0200 Subject: [PATCH 01/13] Add badges --- README.md | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index fec6d41..57b007a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Wallabag for YunoHost -[![Integration level](https://dash.yunohost.org/integration/wallabag2.svg)](https://dash.yunohost.org/appci/app/wallabag2) +[![Integration level](https://dash.yunohost.org/integration/wallabag2.svg)](https://dash.yunohost.org/appci/app/wallabag2) ![](https://ci-apps.yunohost.org/ci/badges/wallabag2.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/wallabag2.maintain.svg) [![Install Wallabag with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=wallabag2) *[Lire ce readme en français.](./README_fr.md)* @@ -10,8 +10,7 @@ If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to ## Overview -[Wallabag](https://www.wallabag.org/) is a self hostable Read-It-Later application allowing -you to not miss any content anymore. Click, save, read it when you can. +[Wallabag](https://www.wallabag.org/) is a self hostable Read-It-Later application allowing you to not miss any content anymore. Click, save, read it when you can. It extracts content so that you can read it when you have time. It provides a web interface, browser (Firefox / Chrome / Opera) add-ons, mobile apps (Android / iOS / Windows Phone) and even on e-reader (PocketBook / Kobo). @@ -36,8 +35,7 @@ It provides a web interface, browser (Firefox / Chrome / Opera) add-ons, mobile ## YunoHost specific features -In addition to Wallabag core features, the following are made available with -this package: +In addition to Wallabag core features, the following are made available with this package: * Integrate with YunoHost users and SSO - i.e. logout button * Allow one user to be the administrator (set at the installation) @@ -47,9 +45,8 @@ this package: #### Supported architectures -* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/wallabag2%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/wallabag2/) +* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/wallabag2%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/wallabag2/) * ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/wallabag2%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/wallabag2/) -* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/wallabag2%20%28Apps%29.svg)](https://ci-stretch.nohost.me/ci/apps/wallabag2/) ## Limitations @@ -75,10 +72,8 @@ For the migration process, please refer to the --- -Developers and testers info ----------------- +## Developers and testers info -**Only if you want to use a testing branch for coding, instead of merging directly into master.** Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/wallabag2_ynh/tree/testing). To try the testing branch, please proceed like that: From 0e921ba0d5e29c56d4d96b6867b55565e77ff0b0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Thu, 22 Oct 2020 15:19:43 +0200 Subject: [PATCH 02/13] Add badges --- README_fr.md | 35 ++++++++++++++++------------------- 1 file changed, 16 insertions(+), 19 deletions(-) diff --git a/README_fr.md b/README_fr.md index b44b297..d47f30e 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,18 +1,18 @@ # Wallabag pour YunoHost -[![Integration level](https://dash.yunohost.org/integration/wallabag2.svg)](https://dash.yunohost.org/appci/app/wallabag2) +[![Integration level](https://dash.yunohost.org/integration/wallabag2.svg)](https://dash.yunohost.org/appci/app/wallabag2) ![](https://ci-apps.yunohost.org/ci/badges/wallabag2.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/wallabag2.maintain.svg) [![Install Wallabag with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=wallabag2) *[Read this readme in english.](./README.md)* -> *Ce package vous permet d'installer Wallabag rapidement et simplement sur un serveur Yunohost. +> *Ce package vous permet d'installer Wallabag 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.* ## Vue d'ensemble [Wallabag](https://www.wallabag.org/) est une application de lecture différée : elle permet simplement d’archiver une page web en ne conservant que le contenu. Les éléments superflus (menus, publicités, etc.) sont supprimés. -Sont disponibles: une interface web, des add-ons pour navigateurs (Firefox / Chrome / Opera), des applications pour mobile (Android / iOS / Windows Phone) et même sur liseuse (PocketBook / Kobo). +Sont disponibles une interface web, des add-ons pour navigateurs (Firefox / Chrome / Opera), des applications pour mobile (Android / iOS / Windows Phone) et même sur liseuse (PocketBook / Kobo). **Version incluse:** 2.3.8 @@ -29,14 +29,14 @@ Sont disponibles: une interface web, des add-ons pour navigateurs (Firefox / Chr ## Documentation - * Documentation officielle: https://doc.wallabag.org/fr/ - * Documentation YunoHost: https://yunohost.org/#/app_wallabag2 + * Documentation officielle : https://doc.wallabag.org/fr/ + * Documentation YunoHost : https://yunohost.org/#/app_wallabag2 ## Caractéristiques spécifiques YunoHost -En plus des fonctionnalités principales de Wallabag, ce paquet propose également: +En plus des fonctionnalités principales de Wallabag, ce paquet propose également : - * Une intégration avec le système de gestion des utilisateurs et le SSO de Yunohost - e.g. un bouton de déconnexion + * Une intégration avec le système de gestion des utilisateurs et le SSO de YunoHost - e.g. un bouton de déconnexion * De permettre à un utilisateur d'être administrateur (réglage lors de l'installation) * Un import asynchrone utilisant Redis (à activer dans les *Paramètres Internes*). L'import via RabbitMQ n'est pas (encore ?) supporté. @@ -44,13 +44,12 @@ En plus des fonctionnalités principales de Wallabag, ce paquet propose égaleme #### Supported architectures -* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/wallabag2%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/wallabag2/) +* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/wallabag2%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/wallabag2/) * ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/wallabag2%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/wallabag2/) -* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/wallabag2%20%28Apps%29.svg)](https://ci-stretch.nohost.me/ci/apps/wallabag2/) ## Limitations -* Supprimer un utilisateur Yunohost ne supprimera pas l'utilisateur Wallabag lié, il sera seulement désactivé. Vous devez le supprimer manuellement avant. Voir: https://github.com/YunoHost-Apps/wallabag2_ynh/issues/39 +* Supprimer un utilisateur YunoHost ne supprimera pas l'utilisateur Wallabag lié, il sera seulement désactivé. Vous devez le supprimer manuellement avant. Voir : https://github.com/YunoHost-Apps/wallabag2_ynh/issues/39 ## Informations additionnelles @@ -59,25 +58,23 @@ En plus des fonctionnalités principales de Wallabag, ce paquet propose égaleme #### Mettre à niveau depuis la v1 -La mise à niveau depuis le paquet Yunohost de [Wallabag v1](https://github.com/YunoHost-Apps/wallabag_ynh) demande une opération manuelle, c'est pourquoi un nouveau paquet est fournit. +La mise à niveau depuis le paquet YunoHost de [Wallabag v1](https://github.com/YunoHost-Apps/wallabag_ynh) demande une opération manuelle, c'est pourquoi un nouveau paquet est fournit. Pour le processus de migration, merci de vous référer à [la documentation officiel de Wallabag](https://doc.wallabag.org/fr/user/import/wallabagv1.html). ## Links - * Signaler un bug: https://github.com/YunoHost-Apps/wallabag2_ynh/issues - * Site de l'application: https://www.wallabag.org/ - * Dépôt de l'application principale: https://github.com/wallabag/wallabag - * Site web YunoHost: https://yunohost.org/ + * Signaler un bug : https://github.com/YunoHost-Apps/wallabag2_ynh/issues + * Site de l'application : https://www.wallabag.org/ + * Dépôt de l'application principale : https://github.com/wallabag/wallabag + * Site web YunoHost : https://yunohost.org/ --- -Informations pour les développeurs ----------------- +## Informations pour les développeurs -**Seulement si vous voulez utiliser une branche de test pour le codage, au lieu de fusionner directement dans la banche principale.** Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/wallabag2_ynh/tree/testing). -Pour essayer la branche testing, procédez comme ceci: +Pour essayer la branche testing, procédez comme ceci : ``` sudo yunohost app install https://github.com/YunoHost-Apps/wallabag2_ynh/tree/testing --debug ou From e7abd276e3e6e87178a127f75fd6ade21e0f44c1 Mon Sep 17 00:00:00 2001 From: Yunohost-Bot <> Date: Mon, 15 Mar 2021 00:23:05 +0100 Subject: [PATCH 03/13] [autopatch] Missing ynh_abort_if_errors in change_url scripts --- scripts/change_url | 1 + 1 file changed, 1 insertion(+) diff --git a/scripts/change_url b/scripts/change_url index d26bf9f..7db3313 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -8,6 +8,7 @@ source _common.sh source /usr/share/yunohost/helpers +ynh_abort_if_errors #================================================= # RETRIEVE ARGUMENTS From b21f9406f671cf5c7cbe52a05cf52e8146376f92 Mon Sep 17 00:00:00 2001 From: Yunohost-Bot <> Date: Mon, 15 Mar 2021 00:27:47 +0100 Subject: [PATCH 04/13] [autopatch] Autopatch to migrate to new permission system --- scripts/install | 3 ++- scripts/upgrade | 10 ++++++++++ 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/scripts/install b/scripts/install index 1005880..692bddf 100644 --- a/scripts/install +++ b/scripts/install @@ -178,9 +178,10 @@ ynh_replace_string --match_string="__APP__" --replace_string="$app" --target_fil # SETUP SSOWAT #================================================= ynh_script_progression --message="Configuring SSOwat..." +ynh_permission_update --permission="main" --add="visitors" # Set SSOwat rules -ynh_app_setting_set $app unprotected_uris "/" + #================================================= # RELOAD NGINX diff --git a/scripts/upgrade b/scripts/upgrade index baa15cf..1170198 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -68,6 +68,16 @@ ynh_clean_setup () { # Exit if an error occurs during the execution of the script ynh_abort_if_errors +#================================================= +# Migrate legacy permissions to new system +#================================================= +if ynh_legacy_permissions_exists +then + ynh_legacy_permissions_delete_all + + ynh_app_setting_delete --app=$app --key=is_public +fi + #================================================= # CHECK THE PATH #================================================= From e563ac322646d327b651e038705c18b8250bcf0d Mon Sep 17 00:00:00 2001 From: Alexandre Aubin Date: Tue, 6 Apr 2021 14:44:43 +0200 Subject: [PATCH 05/13] Remove stale comment --- scripts/install | 3 --- 1 file changed, 3 deletions(-) diff --git a/scripts/install b/scripts/install index 692bddf..375add7 100644 --- a/scripts/install +++ b/scripts/install @@ -180,9 +180,6 @@ ynh_replace_string --match_string="__APP__" --replace_string="$app" --target_fil ynh_script_progression --message="Configuring SSOwat..." ynh_permission_update --permission="main" --add="visitors" -# Set SSOwat rules - - #================================================= # RELOAD NGINX #================================================= From 0be55edf0db3c46b2bd7519939c6125ec7358a3c Mon Sep 17 00:00:00 2001 From: Jules-Bertholet Date: Thu, 8 Apr 2021 16:59:54 -0400 Subject: [PATCH 06/13] Tighten permissions (#99) * Tighten permissions * Check for existence of cache file before chmoding it --- scripts/_common.sh | 16 ++++++++++++++++ scripts/install | 7 +------ scripts/restore | 5 +++-- scripts/upgrade | 7 +------ 4 files changed, 21 insertions(+), 14 deletions(-) diff --git a/scripts/_common.sh b/scripts/_common.sh index ab8759c..bf96bab 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -7,6 +7,22 @@ # dependencies used by the app pkg_dependencies="php-cli php-mysql php-json php-gd php-tidy php-curl php-gettext php-redis" +#================================================= +# PERSONAL HELPERS +#================================================= + +function set_permissions { + # Set permissions to app files + chown -R $app:www-data $final_path + chmod -R g=u,g-w,o-rwx $final_path + + # Restrict rights to Wallabag user only + chmod 600 $wb_conf + if [ -e $final_path/var/cache/prod/appProdProjectContainer.php ]; then + chmod 700 $final_path/var/cache/prod/appProdProjectContainer.php + fi +} + #================================================= # EXPERIMENTAL HELPERS #================================================= diff --git a/scripts/install b/scripts/install index 375add7..8867d0f 100644 --- a/scripts/install +++ b/scripts/install @@ -160,12 +160,7 @@ ynh_add_fail2ban_config --logpath="/var/www/$app/var/logs/prod.log" --failregex= # SECURE FILES AND DIRECTORIES #================================================= -# Restrict rights to Wallabag user only -chmod 600 $wb_conf - -# Set permissions to app files -chown -R $app: $final_path -chmod 755 $final_path +set_permissions #================================================= # SETUP HOOKS diff --git a/scripts/restore b/scripts/restore index ec62624..1654db7 100644 --- a/scripts/restore +++ b/scripts/restore @@ -66,8 +66,9 @@ ynh_system_user_create --username=$app # RESTORE USER RIGHTS #================================================= -# Restore permissions on app files -chown -R $app: $final_path +wb_conf=$final_path/app/config/parameters.yml + +set_permissions #================================================= # RESTORE THE PHP-FPM CONFIGURATION diff --git a/scripts/upgrade b/scripts/upgrade index 1170198..94bc0d9 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -191,12 +191,7 @@ fi # SECURE FILES AND DIRECTORIES #================================================= -# Restrict rights to Wallabag user only -chmod 600 $wb_conf - -# Set permissions to app files -chown -R $app: $final_path -chmod 755 $final_path +set_permissions #================================================= # SETUP HOOKS From d87c241cfa5637e30e2427a2ec3a157c18d121c8 Mon Sep 17 00:00:00 2001 From: Jules-Bertholet Date: Thu, 8 Apr 2021 17:01:03 -0400 Subject: [PATCH 07/13] Install PHP packages of YNH_PHP_VERSION (#100) Quash the last package_check warning --- scripts/_common.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/_common.sh b/scripts/_common.sh index bf96bab..f58d4bf 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -5,7 +5,7 @@ #================================================= # dependencies used by the app -pkg_dependencies="php-cli php-mysql php-json php-gd php-tidy php-curl php-gettext php-redis" +pkg_dependencies="php$YNH_DEFAULT_PHP_VERSION-cli php$YNH_DEFAULT_PHP_VERSION-mysql php$YNH_DEFAULT_PHP_VERSION-json php$YNH_DEFAULT_PHP_VERSION-gd php$YNH_DEFAULT_PHP_VERSION-tidy php$YNH_DEFAULT_PHP_VERSION-curl php$YNH_DEFAULT_PHP_VERSION-gettext php$YNH_DEFAULT_PHP_VERSION-redis" #================================================= # PERSONAL HELPERS From 515205876206128677e1ca4d7b7b70c8d8eea7b0 Mon Sep 17 00:00:00 2001 From: lapineige Date: Fri, 9 Apr 2021 10:04:14 +0200 Subject: [PATCH 08/13] Update package version + yunohost requirements CI gives us this warning: > ! Using official helper ynh_permission_update implies requiring at least version 3.7.0, but manifest only requires 3.5 --- manifest.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/manifest.json b/manifest.json index 6908b1c..af4a8cd 100644 --- a/manifest.json +++ b/manifest.json @@ -6,7 +6,7 @@ "en": "A self hostable read-it-later app", "fr": "Une application de lecture-plus-tard auto-hébergeable" }, - "version": "2.3.8~ynh2", + "version": "2.3.8~ynh3", "url": "https://www.wallabag.org", "license": "MIT", "maintainer": { @@ -14,7 +14,7 @@ "email": "" }, "requirements": { - "yunohost": ">= 3.5" + "yunohost": ">= 3.7.0" }, "multi_instance": true, "services": [ From eefec146158ebb6e4eafc505e971238e14e8cc5e Mon Sep 17 00:00:00 2001 From: JimboJoe Date: Fri, 9 Apr 2021 10:08:23 +0200 Subject: [PATCH 09/13] Upgrade to upstream version 2.4.2 (closes #88) (#90) * Upgrade to upstream version 2.4.2 --- README.md | 2 +- README_fr.md | 2 +- conf/app.src | 4 ++-- manifest.json | 2 +- scripts/change_url | 3 --- scripts/install | 3 --- scripts/upgrade | 12 +++++++++--- 7 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 57b007a..a7cd47e 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ It extracts content so that you can read it when you have time. It provides a web interface, browser (Firefox / Chrome / Opera) add-ons, mobile apps (Android / iOS / Windows Phone) and even on e-reader (PocketBook / Kobo). -**Shipped version:** 2.3.8 +**Shipped version:** 2.4.2 ## Screenshots diff --git a/README_fr.md b/README_fr.md index d47f30e..00b0cb0 100644 --- a/README_fr.md +++ b/README_fr.md @@ -14,7 +14,7 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour Sont disponibles une interface web, des add-ons pour navigateurs (Firefox / Chrome / Opera), des applications pour mobile (Android / iOS / Windows Phone) et même sur liseuse (PocketBook / Kobo). -**Version incluse:** 2.3.8 +**Version incluse:** 2.4.2 ## Captures d'écran diff --git a/conf/app.src b/conf/app.src index 4ab2afd..41bda61 100644 --- a/conf/app.src +++ b/conf/app.src @@ -1,5 +1,5 @@ -SOURCE_URL=https://static.wallabag.org/releases/wallabag-release-2.3.8.tar.gz -SOURCE_SUM=58f319ee41828fcc4fd00a14c4ac7c16b2179a47af21e257a15938311d1426eb +SOURCE_URL=https://static.wallabag.org/releases/wallabag-release-2.4.2.tar.gz +SOURCE_SUM=da56ec37ed3d78a4b4132e8a248ac4997442eefaad6f831805304a8c317569d8 SOURCE_SUM_PRG=sha256sum SOURCE_FORMAT=tar.gz SOURCE_IN_SUBDIR=true diff --git a/manifest.json b/manifest.json index af4a8cd..2d4dfd5 100644 --- a/manifest.json +++ b/manifest.json @@ -6,7 +6,7 @@ "en": "A self hostable read-it-later app", "fr": "Une application de lecture-plus-tard auto-hébergeable" }, - "version": "2.3.8~ynh3", + "version": "2.4.2~ynh1", "url": "https://www.wallabag.org", "license": "MIT", "maintainer": { diff --git a/scripts/change_url b/scripts/change_url index 7db3313..b49b957 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -84,9 +84,6 @@ fi #================================================= ynh_script_progression --message="Updating wallabag configuration..." -# Configure Wallabag instance URL -ynh_mysql_connect_as --user=$db_user --password="$db_pwd" --database=$db_name <<< "UPDATE craue_config_setting SET value = 'https://$new_domain$new_path' WHERE name = 'wallabag_url'" - # Change domain name in parameters.yml ynh_replace_string --match_string="domain_name: .*" --replace_string="domain_name: https://$new_domain$new_path" --target_file=$final_path/app/config/parameters.yml diff --git a/scripts/install b/scripts/install index 8867d0f..ab4ea3c 100644 --- a/scripts/install +++ b/scripts/install @@ -141,9 +141,6 @@ done # Set admin user $php_exec fos:user:promote --super "$admin" -# Configure Wallabag instance URL -ynh_mysql_connect_as --user=$db_user --password="$db_pwd" --database=$db_name <<< "UPDATE craue_config_setting SET value = 'https://$domain$path_url' WHERE name = 'wallabag_url'" - #================================================= # CONFIGURE FAIL2BAN #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index 94bc0d9..779a2dc 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -172,7 +172,7 @@ then #================================================= # Alias for php-cli execution command - php_exec="ynh_exec_as $app php "$final_path/bin/console" --no-interaction --env=prod" + php_exec="ynh_exec_as $app php "$final_path/bin/console" --no-interaction --env prod" # Set permissions to app files chown -R $app: $final_path @@ -181,8 +181,14 @@ then $php_exec doctrine:migrations:migrate $php_exec cache:clear - # Configure Wallabag instance URL - ynh_mysql_connect_as --user=$db_user --password="$db_pwd" --database=$db_name <<< "UPDATE craue_config_setting SET value = 'https://$domain$path_url' WHERE name = 'wallabag_url'" + current_upstream_version="$(ynh_app_upstream_version --manifest="/etc/yunohost/apps/$YNH_APP_INSTANCE_NAME/manifest.json")" + if dpkg --compare-versions "2.4.2" gt "$current_upstream_version"; then + ynh_script_progression --message="Ensuring upgrade compatibility to Wallabag 2.4.x..." + + # Generate hashed URLs for faster check + # TODO does it take much time... ? + $php_exec wallabag:generate-hashed-urls + fi fi #================================================= From afdd82cbed98b66ff2bf31c30f86ea8f704154f7 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Sat, 24 Apr 2021 12:55:59 +0200 Subject: [PATCH 10/13] version 4.1.0 ! Using official helper ynh_legacy_permissions_delete_all implies requiring at least version 4.1, but manifest only requires 3.7.0 ! Using official helper ynh_legacy_permissions_exists implies requiring at least version 4.1, but manifest only requires 3.7.0 --- manifest.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/manifest.json b/manifest.json index 2d4dfd5..b41b677 100644 --- a/manifest.json +++ b/manifest.json @@ -14,7 +14,7 @@ "email": "" }, "requirements": { - "yunohost": ">= 3.7.0" + "yunohost": ">= 4.1.0" }, "multi_instance": true, "services": [ From d42b2102a1433594b55f7e7549ec096fa404f098 Mon Sep 17 00:00:00 2001 From: YunoHost Bot Date: Tue, 11 May 2021 08:30:06 +0200 Subject: [PATCH 11/13] [autopatch] Update issue and PR templates (#102) Co-authored-by: Yunohost-Bot <> --- pull_request_template.md | 24 ------------------------ 1 file changed, 24 deletions(-) delete mode 100644 pull_request_template.md diff --git a/pull_request_template.md b/pull_request_template.md deleted file mode 100644 index 4c09327..0000000 --- a/pull_request_template.md +++ /dev/null @@ -1,24 +0,0 @@ -## Problem -- *Description of why you made this PR* - -## Solution -- *And how you fix that* - -## PR Status -- [ ] Code finished. -- [ ] Tested with Package_check. -- [ ] Fix or enhancement tested. -- [ ] Upgrade from last version tested. -- [ ] Can be reviewed and tested. - -## Validation ---- -*Minor decision* -- **Upgrade previous version** : -- [ ] **Code review** : -- [ ] **Approval (LGTM)** : -- [ ] **Approval (LGTM)** : -- **CI succeeded** : -[![Build Status](https://ci-apps-hq.yunohost.org/jenkins/job/wallabag2_ynh%20PR-NUM-/badge/icon)](https://ci-apps-hq.yunohost.org/jenkins/job/wallabag2_ynh%20PR-NUM-/) -*Please replace '-NUM-' in this link by the PR number.* -When the PR is marked as ready to merge, you have to wait for 3 days before really merging it. From d40d78b02813b32969c175060761e9ded797e7bf Mon Sep 17 00:00:00 2001 From: lapineige Date: Tue, 11 May 2021 08:31:28 +0200 Subject: [PATCH 12/13] Revert "[autopatch] Update issue and PR templates (#102)" (#103) This reverts commit d42b2102a1433594b55f7e7549ec096fa404f098. --- pull_request_template.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 pull_request_template.md diff --git a/pull_request_template.md b/pull_request_template.md new file mode 100644 index 0000000..4c09327 --- /dev/null +++ b/pull_request_template.md @@ -0,0 +1,24 @@ +## Problem +- *Description of why you made this PR* + +## Solution +- *And how you fix that* + +## PR Status +- [ ] Code finished. +- [ ] Tested with Package_check. +- [ ] Fix or enhancement tested. +- [ ] Upgrade from last version tested. +- [ ] Can be reviewed and tested. + +## Validation +--- +*Minor decision* +- **Upgrade previous version** : +- [ ] **Code review** : +- [ ] **Approval (LGTM)** : +- [ ] **Approval (LGTM)** : +- **CI succeeded** : +[![Build Status](https://ci-apps-hq.yunohost.org/jenkins/job/wallabag2_ynh%20PR-NUM-/badge/icon)](https://ci-apps-hq.yunohost.org/jenkins/job/wallabag2_ynh%20PR-NUM-/) +*Please replace '-NUM-' in this link by the PR number.* +When the PR is marked as ready to merge, you have to wait for 3 days before really merging it. From f88f43959bc591c4cca5461c6465e03ddb953086 Mon Sep 17 00:00:00 2001 From: YunoHost Bot Date: Thu, 13 May 2021 19:56:19 +0200 Subject: [PATCH 13/13] [autopatch] Update issue and PR templates (#104) Co-authored-by: Yunohost-Bot <> --- .github/ISSUE_TEMPLATE.md | 55 ++++++++++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 16 ++++++++++ pull_request_template.md | 24 -------------- 3 files changed, 71 insertions(+), 24 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..2729a6b --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,55 @@ +--- +name: Bug report +about: When creating a bug report, please use the following template to provide all the relevant information and help debugging efficiently. + +--- + +**How to post a meaningful bug report** +1. *Read this whole template first.* +2. *Determine if you are on the right place:* + - *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change_url...), you are on the right place!* + - *Otherwise, the issue may be due to the app itself. Refer to its documentation or repository for help.* + - *When in doubt, post here and we will figure it out together.* +3. *Delete the italic comments as you write over them below, and remove this guide.* +--- + +### Describe the bug + +*A clear and concise description of what the bug is.* + +### Context + +- Hardware: *VPS bought online / Old laptop or computer / Raspberry Pi at home / Internet Cube with VPN / Other ARM board / ...* +- YunoHost version: x.x.x +- I have access to my server: *Through SSH | through the webadmin | direct access via keyboard / screen | ...* +- Are you in a special context or did you perform some particular tweaking on your YunoHost instance?: *no / yes* + - If yes, please explain: +- Using, or trying to install package version/branch: +- If upgrading, current package version: *can be found in the admin, or with `yunohost app info $app_id`* + +### Steps to reproduce + +- *If you performed a command from the CLI, the command itself is enough. For example:* + ```sh + sudo yunohost app install the_app + ``` +- *If you used the webadmin, please perform the equivalent command from the CLI first.* +- *If the error occurs in your browser, explain what you did:* + 1. *Go to '...'* + 2. *Click on '...'* + 3. *Scroll down to '...'* + 4. *See error* + +### Expected behavior + +*A clear and concise description of what you expected to happen. You can remove this section if the command above is enough to understand your intent.* + +### Logs + +*When an operation fails, YunoHost provides a simple way to share the logs.* +- *In the webadmin, the error message contains a link to the relevant log page. On that page, you will be able to 'Share with Yunopaste'. If you missed it, the logs of previous operations are also available under Tools > Logs.* +- *In command line, the command to share the logs is displayed at the end of the operation and looks like `yunohost log display [log name] --share`. If you missed it, you can find the log ID of a previous operation using `yunohost log list`.* + +*After sharing the log, please copypaste directly the link provided by YunoHost (to help readability, no need to copypaste the entire content of the log here, just the link is enough...)* + +*If applicable and useful, add screenshots to help explain your problem.* diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..ef70e18 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,16 @@ +## Problem + +- *Description of why you made this PR* + +## Solution + +- *And how do you fix that problem* + +## PR Status + +- [ ] Code finished and ready to be reviewed/tested +- [ ] The fix/enhancement were manually tested (if applicable) + +## Automatic tests + +Automatic tests can be triggered on https://ci-apps-dev.yunohost.org/ *after creating the PR*, by commenting "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!". (N.B. : for this to work you need to be a member of the Yunohost-Apps organization) diff --git a/pull_request_template.md b/pull_request_template.md deleted file mode 100644 index 4c09327..0000000 --- a/pull_request_template.md +++ /dev/null @@ -1,24 +0,0 @@ -## Problem -- *Description of why you made this PR* - -## Solution -- *And how you fix that* - -## PR Status -- [ ] Code finished. -- [ ] Tested with Package_check. -- [ ] Fix or enhancement tested. -- [ ] Upgrade from last version tested. -- [ ] Can be reviewed and tested. - -## Validation ---- -*Minor decision* -- **Upgrade previous version** : -- [ ] **Code review** : -- [ ] **Approval (LGTM)** : -- [ ] **Approval (LGTM)** : -- **CI succeeded** : -[![Build Status](https://ci-apps-hq.yunohost.org/jenkins/job/wallabag2_ynh%20PR-NUM-/badge/icon)](https://ci-apps-hq.yunohost.org/jenkins/job/wallabag2_ynh%20PR-NUM-/) -*Please replace '-NUM-' in this link by the PR number.* -When the PR is marked as ready to merge, you have to wait for 3 days before really merging it.