Update tools.func wiki page for clarity

[arian-nasr]

📌 Task summary

Update information for tools.func wiki page entry

📋 Task details

I was recently looking at the update sources for some of the scripts and I was trying to determine what the function fetch_and_deploy_gh_release() does. The wiki page is missing a lot of important parameters for the command.

May I suggest adding the following to the "Usage" section for the function:

https://github.com/community-scripts/ProxmoxVE/wiki/tools.func

Usage

fetch_and_deploy_gh_release <app> <repo> [mode] [version] [target] [asset_pattern]

Basic usage with defaults (tarball mode, latest version)

fetch_and_deploy_gh_release "MyApp" "owner/repository"

Install specific version as binary (.deb package)

fetch_and_deploy_gh_release "MyApp" "owner/repo" "binary" "v2.1.0"

Install prebuild archive with custom target and asset pattern

fetch_and_deploy_gh_release "MyApp" "owner/repo" "prebuild" "latest" "/usr/local/myapp" "*-linux-amd64.tar.gz"

I suggest these changes as they helped me understand the function better and maybe it can help someone else too 👍

[arian-nasr]

I double checked and I think the mode parameter is also required. So the current wiki might be incorrect as the default is missing the mode parameter.

[tremor021]

The docs are going through a overhaul, so atm a lot of info is not up to date. We did lot of work on the tools.func and other backend scripts to provide users lots of interesting and useful functions.

The new and updated docs are coming, please bear with us. All this takes time, but end result will be awesome.
Stay tuned on that.

Regarding fetch_and_deploy_gh_release function, only app name and repo are mandatory, rest is optional, depending on the type of release we are trying to fetch. Mode is assumed "tarball" or "source" if none is specified. The function itself has more parameters like CLEAN_INSTALL and USE_ORIGINAL_FILENAME, which need to be mentioned for specific release types, former beign more used for update procedures while latter controls the output file name.

Anyway, the update to the docs is in the works. Can't say when the changes will be applied, but i hope as soon as we finish migrating and testing scripts from Debian 12 to Debian 13 base.