No documentation for developing app helpers

lotigara commented 1 month ago

please sorry for my english

Labels

📖 documentation, 🤓 helpers

Describe the bug

There is no documented way to modify app helpers completely

Context

Hardware: New computer
YunoHost version: 11.2.27
I have access to my server: Through SSH & through the webadmin
Are you in a special context or did you perform some particular tweaking on your YunoHost instance?: yes
- Please explain: I'm trying to tweak a nginx helper, see #2427. I set up development environment on my Bullseye server as here (I tried to setup a LXC container, but result was unsuccessful).

To reproduce

Set up development environment on a YunoHost Bullseye server
cd /ynh-dev/ && ./ynh-dev use-git yunohost && editor yunohost/helpers/helpers.v2.1.d/nginx Note that when I modify a helper, it's counterpant in /usr/share/yunohost/helpers.v2.1.d/ changes too.
cd $PATH_TO_APP && yunohost app install . App's install script doesn't see new helper, and when an old one was modified, script didn't saw changes.

Expected behavior

A documented instruction to re-generate app helpers

Logs

https://paste.yunohost.org/raw/uhoyijegir, there is also a helper at helpers/helpers.v2.1.d/nginx:

[other helpers]

ynh_config_add_nginx_site() {

    local finalnginxconf="/etc/nginx/sites-available/$app.conf"

    ynh_config_add --template="nginx.site" --destination="$finalnginxconf"

    if [ "${path:-}" != "/" ]; then
        ynh_replace --match="^#sub_path_only" --replace="" --file="$finalnginxconf"
    else
        ynh_replace --match="^#root_path_only" --replace="" --file="$finalnginxconf"
    fi

    ynh_store_file_checksum "$finalnginxconf"

    ln -s /etc/nginx/sites-{available,enabled}/$app.conf

    ynh_systemctl --service=nginx --action=reload
}

[other helpers]

alexAubin commented 1 month ago

Can you confirm that you're using an up to date version of ynh-dev, in particular including this commit ? https://github.com/YunoHost/ynh-dev/commit/ce294e69ab6010f9796644576db86d6b89eb039b

lotigara commented 1 month ago

Can you confirm that you're using an up to date version of ynh-dev, in particular including this commit ? YunoHost/ynh-dev@ce294e6

Yes, I'm using up-to-date version. Commit you mentioned is listed in my git shortlog

YunoHost / issues