Apply last example

2024-09-03 18:36:04 +02:00 · 2022-03-19 19:08:33 +01:00 · 2022-03-19 19:08:33 +01:00 · 94cb70f4e5
commit 94cb70f4e5
parent 4f4a2db7c6
15 changed files with 126 additions and 55 deletions
--- a/.github/ISSUE_TEMPLATE.md
+++ 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.*
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ 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)
--- a/README.md
+++ b/README.md
@ -17,7 +17,7 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in

 Excalidraw is a virtual collaborative whiteboard tool that lets you easily sketch diagrams that have a hand-drawn feel to them.

-**Shipped version:** 0.10.0~ynh1
+**Shipped version:** 0.11.0~ynh1

 **Demo:** https://excalidraw.com/

--- a/README_fr.md
+++ b/README_fr.md
@ -13,7 +13,7 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour

 Excalidraw est un outil de tableau blanc collaboratif virtuel qui vous permet d'esquisser facilement des diagrammes qui ont l'impression d'être dessinés à la main.

-**Version incluse :** 0.10.0~ynh1
+**Version incluse :** 0.11.0~ynh1

 **Démo :** https://excalidraw.com/

--- a/conf/app.src
+++ b/conf/app.src
@ -1,5 +1,7 @@
-SOURCE_URL=https://github.com/excalidraw/excalidraw/releases/download/v0.10.0/excalidraw-excalidraw-0.10.0.tgz
-SOURCE_SUM=764d539c638d574aa65f5371253fd455aea7a4a4fbaef930a6b13af2ed7692a4
+SOURCE_URL=https://github.com/excalidraw/excalidraw/archive/refs/tags/v0.11.0.tar.gz
+SOURCE_SUM=24b0a94b93b82844f53d9c2372990d1e2a3a820a28e2c1b21e07099b6569b8c4
 SOURCE_SUM_PRG=sha256sum
 SOURCE_FORMAT=tar.gz
 SOURCE_IN_SUBDIR=true
+SOURCE_FILENAME=
+SOURCE_EXTRACT=true
--- a/conf/systemd.service
+++ b/conf/systemd.service
@ -7,9 +7,10 @@ Type=simple
 User=__APP__
 Group=__APP__
 WorkingDirectory=__FINALPATH__/
-Environment="PATH=__ENV_PATH__"
+Environment="__YNH_NODE_LOAD_PATH__"
 Environment="NODE_ENV=production"
-ExecStart=__YNH_NODE__ start
+Environment="PORT=__PORT__"
+ExecStart=/usr/bin/yarn start
 Restart=always

 [Install]
--- a/doc/DESCRIPTION.md
+++ b/doc/DESCRIPTION.md
@ -1 +1 @@
-Excalidraw is a virtual collaborative whiteboard tool that lets you easily sketch diagrams that have a hand-drawn feel to them.
+Excalidraw is a virtual collaborative whiteboard tool that lets you easily sketch diagrams that have a hand-drawn feel to them.
--- a/doc/DESCRIPTION_fr.md
+++ b/doc/DESCRIPTION_fr.md
@ -1 +1 @@
-Excalidraw est un outil de tableau blanc collaboratif virtuel qui vous permet d'esquisser facilement des diagrammes qui ont l'impression d'être dessinés à la main.
+Excalidraw est un outil de tableau blanc collaboratif virtuel qui vous permet d'esquisser facilement des diagrammes qui ont l'impression d'être dessinés à la main.
--- a/doc/DISCLAIMER.md
+++ b/doc/DISCLAIMER.md
--- a/manifest.json
+++ b/manifest.json
@ -6,12 +6,12 @@
        "en": "Virtual whiteboard for sketching hand-drawn like diagrams",
        "fr": "Tableau blanc collaboratif virtuel qui vous permet d'esquisser facilement des diagrammes"
    },
-    "version": "0.10.0~ynh1",
+    "version": "0.11.0~ynh1",
    "url": "https://excalidraw.com/",
    "upstream": {
        "license": "MIT",
-        "website": "https://excalidraw.com/",
-        "demo": "https://excalidraw.com/",
+        "website": "https://excalidraw.com",
+        "demo": "https://excalidraw.com",
        "code": "https://github.com/excalidraw/excalidraw"
    },
    "license": "MIT",
@ -40,10 +40,6 @@
            {
                "name": "is_public",
                "type": "boolean",
-                "help": {
-                    "en": "If enabled, Excalidraw will be accessible by people who do not have an account. This can be changed later via the webadmin.",
-                    "fr": "Si cette case est cochée, Excalidraw sera accessible aux personnes n’ayant pas de compte. Vous pourrez changer ceci plus tard via la webadmin."
-                },
                "default": true
            }
        ]
--- a/scripts/backup
+++ b/scripts/backup
@ -6,6 +6,7 @@
 # IMPORT GENERIC HELPERS
 #=================================================

+# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
 source ../settings/scripts/_common.sh
 source /usr/share/yunohost/helpers

@ -14,7 +15,7 @@ source /usr/share/yunohost/helpers
 #=================================================

 ynh_clean_setup () {
-	ynh_clean_check_starting
+	true
 }
 # Exit if an error occurs during the execution of the script
 ynh_abort_if_errors
@ -46,6 +47,8 @@ ynh_backup --src_path="$final_path"

 ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf"

+#=================================================
+# SPECIFIC BACKUP
 #=================================================
 # BACKUP LOGROTATE
 #=================================================
--- a/scripts/install
+++ b/scripts/install
@ -47,7 +47,6 @@ 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=final_path --value=$final_path

 #=================================================
 # STANDARD MODIFICATIONS
@ -79,7 +78,7 @@ ynh_install_extra_app_dependencies --repo="deb https://dl.yarnpkg.com/debian/ st
 ynh_script_progression --message="Configuring system user..." --weight=3

 # Create a system user
-ynh_system_user_create --username=$app --home_dir=$final_path
+ynh_system_user_create --username=$app --home_dir="$final_path"

 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
@ -88,7 +87,7 @@ ynh_script_progression --message="Setting up source files..." --weight=2

 ynh_app_setting_set --app=$app --key=final_path --value=$final_path
 # Download, check integrity, uncompress and patch the source from app.src
-ynh_setup_source --dest_dir=$final_path
+ynh_setup_source --dest_dir="$final_path"

 chmod 750 "$final_path"
 chmod -R o-rwx "$final_path"
@ -99,15 +98,15 @@ chown -R $app:www-data "$final_path"
 #=================================================
 ynh_script_progression --message="Configuring NGINX web server..." --weight=2

-# Create a dedicated nginx config
+# Create a dedicated NGINX config
 ynh_add_nginx_config

 #=================================================
 # SPECIFIC SETUP
 #==============================================
-# INSTALL CODIMD
+# BUILD APP
 #==============================================
-ynh_script_progression --message="Building $app... (this will take some time and resources!)" --weight=40
+ynh_script_progression --message="Building app... (this will take some time and resources!)" --weight=40

 pushd "$final_path"
 	ynh_use_nodejs
@ -119,10 +118,11 @@ popd
 #=================================================
 ynh_script_progression --message="Configuring a systemd service..." --weight=1

-ynh_replace_string --match_string="__ENV_PATH__" --replace_string="$PATH" --target_file="../conf/systemd.service"
-
+# Create a dedicated systemd config
 ynh_add_systemd_config

+#=================================================
+# GENERIC FINALIZATION
 #=================================================
 # SETUP LOGROTATE
 #=================================================
@ -155,7 +155,7 @@ 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"
+	ynh_permission_update --permission="main" --add="visitors"
 fi

 #=================================================
--- a/scripts/remove
+++ b/scripts/remove
@ -17,9 +17,6 @@ ynh_script_progression --message="Loading installation settings..." --weight=1
 app=$YNH_APP_INSTANCE_NAME

 domain=$(ynh_app_setting_get --app=$app --key=domain)
-port=$(ynh_app_setting_get --app=$app --key=port)
-db_name=$(ynh_app_setting_get --app=$app --key=db_name)
-db_user=$db_name
 final_path=$(ynh_app_setting_get --app=$app --key=final_path)

 #=================================================
@ -43,16 +40,6 @@ ynh_script_progression --message="Stopping and removing the systemd service..."
 # Remove the dedicated systemd config
 ynh_remove_systemd_config

-#=================================================
-# REMOVE DEPENDENCIES
-#=================================================
-ynh_script_progression --message="Removing dependencies..." --weight=1
-
-# Remove metapackage and its dependencies
-ynh_remove_app_dependencies
-
-ynh_remove_nodejs
-
 #=================================================
 # REMOVE APP MAIN DIR
 #=================================================
@ -64,11 +51,20 @@ ynh_secure_remove --file="$final_path"
 #=================================================
 # REMOVE NGINX CONFIGURATION
 #=================================================
-ynh_script_progression --message="Removing Nginx web server configuration..." --weight=5
+ynh_script_progression --message="Removing NGINX web server configuration..." --weight=5

-# Remove the dedicated nginx config
+# Remove the dedicated NGINX config
 ynh_remove_nginx_config

+#=================================================
+# REMOVE DEPENDENCIES
+#=================================================
+ynh_script_progression --message="Removing dependencies..." --weight=1
+
+# Remove metapackage and its dependencies
+ynh_remove_app_dependencies
+ynh_remove_nodejs
+
 #=================================================
 # GENERIC FINALIZATION
 #=================================================
--- a/scripts/restore
+++ b/scripts/restore
@ -6,6 +6,7 @@
 # IMPORT GENERIC HELPERS
 #=================================================

+# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
 source ../settings/scripts/_common.sh
 source /usr/share/yunohost/helpers

@ -22,7 +23,7 @@ ynh_abort_if_errors
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_script_progression --message="Loading settings..." --weight=1
+ynh_script_progression --message="Loading installation settings..." --weight=1

 app=$YNH_APP_INSTANCE_NAME

@ -35,14 +36,15 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path)
 #=================================================
 ynh_script_progression --message="Validating restoration parameters..." --weight=2

-test ! -d $final_path || ynh_die --message="There is already a directory: $final_path "
+test ! -d $final_path \
+	|| ynh_die --message="There is already a directory: $final_path "

 #=================================================
 # STANDARD RESTORATION STEPS
 #=================================================
 # RESTORE THE NGINX CONFIGURATION
 #=================================================
-ynh_script_progression --message="Restoring 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"

@ -52,7 +54,7 @@ ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
 ynh_script_progression --message="Recreating the dedicated system user..." --weight=1

 # Create the dedicated user (if not existing)
-ynh_system_user_create --username=$app --home_dir=$final_path
+ynh_system_user_create --username=$app --home_dir="$final_path"

 #=================================================
 # RESTORE THE APP MAIN DIR
@ -116,7 +118,7 @@ sleep 60
 #=================================================
 # RELOAD NGINX
 #=================================================
-ynh_script_progression --message="Reloading Nginx web server..." --weight=1
+ynh_script_progression --message="Reloading NGINX web server..." --weight=1

 ynh_systemd_action --service_name=nginx --action=reload

--- a/scripts/upgrade
+++ b/scripts/upgrade
@ -24,19 +24,21 @@ port=$(ynh_app_setting_get --app=$app --key=port)
 #=================================================
 # CHECK VERSION
 #=================================================
+ynh_script_progression --message="Checking version..."

 upgrade_type=$(ynh_check_app_version_changed)

 #=================================================
 # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
 #=================================================
-ynh_script_progression --message="Backing up $app before upgrading (may take a while)..." --weight=20
+ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --weight=20

 # Backup the current version of the app
 ynh_backup_before_upgrade
 ynh_clean_setup () {
-	# restore it if the upgrade fails
-	true
+	ynh_clean_check_starting
+	# Restore it if the upgrade fails
+	ynh_restore_upgradebackup
 }
 # Exit if an error occurs during the execution of the script
 ynh_abort_if_errors
@ -56,7 +58,7 @@ ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd"
 ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1

 # Create a dedicated user (if not existing)
-ynh_system_user_create --username=$app --home_dir=$final_path
+ynh_system_user_create --username=$app --home_dir="$final_path"

 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
@ -79,7 +81,7 @@ chown -R $app:www-data "$final_path"
 #=================================================
 ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=2

-# Create a dedicated nginx config
+# Create a dedicated NGINX config
 ynh_add_nginx_config

 #=================================================
@ -98,12 +100,12 @@ ynh_install_extra_app_dependencies --repo="deb https://dl.yarnpkg.com/debian/ st
 #=================================================
 # SPECIFIC UPGRADE
 #=================================================
-# INSTALL CODIMD
+# BUILD APP
 #=================================================

 if [ "$upgrade_type" == "UPGRADE_APP" ]
 then
-	ynh_script_progression --message="Building $app... (this will take some time and resources!)" --weight=60
+	ynh_script_progression --message="Building app... (this will take some time and resources!)" --weight=60

 	pushd "$final_path"	
 		ynh_use_nodejs
@ -114,9 +116,7 @@ fi
 #=================================================
 # SETUP SYSTEMD
 #=================================================
-ynh_script_progression --message="Configuring a systemd service..." --weight=2
-
-ynh_replace_string --match_string="__ENV_PATH__" --replace_string="$PATH" --target_file="../conf/systemd.service"
+ynh_script_progression --message="Upgrading systemd configuration..." --weight=2

 # Create a dedicated systemd config
 ynh_add_systemd_config