Add build scripts and optimized GitHub Actions

[mr-manuel]

Some script were added to make it much easier for everyone to locally build GUIv2 for a GX device and as WebAssembly.

GitHub Actions were also modified to execute the new scripts, which makes maintenance less time consuming. For example the emscripten and QT version are now always fetched from one single script and do not need to be updated in multiple scripts, GitHub Actions and wiki:

gui-v2/build-wasm-install-requirements.sh

Lines 5 to 7 in 9886dac

	export EMSCRIPTEN=3.1.37
	export QT_VERSION=6.6.3
	export OUTPUTDIR=/opt/venus/build-gx-hostedtoolcache

I tested the scripts on Windows with a fresh Ubuntu WSL container and with GitHub Actions.

After this PR is merged, also the wiki has to be modified and simplified.

I added also a .gitattributes file to fix automatically the line endings of *.sh files, else they were always converted to CRLF instead of LF.

[DanielMcInnes]

Building the wasm version fails for old (20.04) ubuntu installations. Not an issue, but should probably be mentioned somewhere. I didn't capture a log, but it was to do with aqt needing a newer version of python than what you get with that old ubuntu.

Building the wasm version works fine on a fresh ubuntu 24.04 vm.

build-gx-install-requirements.sh fails on a fresh ubuntu 24.04 vm:

Downloading https://updates.victronenergy.com/feeds/venus/release/sdk/venus-dunfell-x86_64-arm-cortexa8hf-neon-toolchain-v3.53.sh
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100  231M  100  231M    0     0  4487k      0  0:00:52  0:00:52 --:--:-- 4538k
sudo: venus-dunfell-x86_64-arm-cortexa8hf-neon-toolchain-v3.53.sh: command not found
ERROR: SDK installation failed.
dmcinnes@dmcinnes-System-Product-Name:~/git/victron/gui-v2$

I can see that the file was downloaded to /tmp, and if I run the command manually:
dmcinnes@dmcinnes-System-Product-Name:/tmp$ sudo ./venus-dunfell-x86_64-arm-cortexa8hf-neon-toolchain-v3.53.sh -y
... it works ok, so it's probably something simple to fix

[DanielMcInnes]

should all these new bash scripts have the executable flag set?

[mr-manuel]

Shouldn't they? Else I have to modify the permissions in GitHub Actions before running the scripts or call them with bash.

[DanielMcInnes]

If I manually install the toolchain:

dmcinnes@dmcinnes-System-Product-Name:/tmp$ sudo ./venus-dunfell-x86_64-arm-cortexa8hf-neon-toolchain-v3.53.sh -y
Victron Energy SDK installer version v3.53
==========================================
The directory "/opt/venus/dunfell-arm-cortexa8hf-neon" already contains a SDK for this architecture.
If you continue, existing files will be overwritten! Proceed [y/N]? Y
Extracting SDK.....................................................................done
Setting it up...done
SDK has been successfully set up and is ready to be used.
Each time you wish to use the SDK in a new shell session, you need to source the environment setup script e.g.
 $ . /opt/venus/dunfell-arm-cortexa8hf-neon/environment-setup-cortexa8hf-neon-ve-linux-gnueabi
dmcinnes@dmcinnes-System-Product-Name:/tmp$ cd
dmcinnes@dmcinnes-System-Product-Name:~$ cd git/victron/gui-v2/
dmcinnes@dmcinnes-System-Product-Name:~/git/victron/gui-v2$ ls
ApplicationContent.qml  build-gx-install-requirements.sh  build-gx.sh  build-wasm-install-requirements.sh  build-wasm.sh  cmake  CMakeLists.txt  CMakeLists.txt.user  components  data  fonts  FrameRateVisualizer.qml  gitdiff  Global.qml  i18n  images  LICENSE.txt  macdeployhelper.sh  Main.qml  nohup.out  pages  qqmlobjectmodel.cpp  README.md  scripts  src  test.py  tests  themes  tools  victron.astyle  windeployhelper.bat

... then source the environment setup stuff:
dmcinnes@dmcinnes-System-Product-Name:~/git/victron/gui-v2$ . /opt/venus/dunfell-arm-cortexa8hf-neon/environment-setup-cortexa8hf-neon-ve-linux-gnueabi

... then start the gx build, I get an error:

dmcinnes@dmcinnes-System-Product-Name:~/git/victron/gui-v2$ ./build-gx.sh
ERROR: Venus OS SDK was not found.
Execute "./build-gx-install-requirements.sh" once or visit this link for how to install and use the SDK: https://github.com/victronenergy/venus/wiki/howto-install-and-use-the-sdk
dmcinnes@dmcinnes-System-Product-Name:~/git/victron/gui-v2$ . /opt/venus/dunfell-arm-cortexa8hf-neon/environment-setup-cortexa8hf-neon-ve-linux-gnueabi 
dmcinnes@dmcinnes-System-Product-Name:~/git/victron/gui-v2$ 

[DanielMcInnes]

I only have a linux box, I can't test this for mac or windows. Would you expect it to work on these platforms?

[blammit]

I understand these scripts make it easier to build, in terms of combining the package installation + configure + build steps, but should these scripts really be in the repo? It looks like they have various specific requirements/assumptions (e.g. Linux builds, doing clean builds, putting build dir inside the repo) so that it may often be easier to build without the scripts. Or, in other cases it is simple enough that you don't need a separate build script (e.g. build-gx.sh). I'm not sure how much benefit we get from adding these scripts, as opposed to having some improved build documentation, and this also creates additional tools that need to be maintained going forward.

[mr-manuel]

@DanielMcInnes if you install manually the Victron SDK you need to create a symlink for /opt/venus/current, which is currently described in the manual, therefore it does not work.

sudo: venus-dunfell-x86_64-arm-cortexa8hf-neon-toolchain-v3.53.sh: command not found

This sould already be fixed. It was because the command executed was sudo script.sh and not sudo ./script.sh.

I tested it on a fresh Ubuntu VM, on Windows with a WSL Ubuntu container and GitHub Actions. All mentioned use Ubuntu 24.04. The scripts won't work natively on Windows. For macOS I'm not sure, but don't think that it will work, since apt-get may be not available there.

@blammit the idea was to make it easy for community members to build the GUI and therefore also to make it attractive for developing and testing custom modifications. It's easy to build the GUI if you have QtCreator installed, but if you have not (like me and nearly all of the community), then this is quite a pain. It's also very complex to setup QtCreator correctly, see #492 and #1389.
To make those scripts easy to find I placed them in the root of the repository, but a subfolder with the proper name should also be fine.

This scripts also reduce maintenance for build scripts used in GitHub Actions, since all needed data is now fetched from the prepare script and those scripts are run to build the wasm file in the GitHub Actions.

From my point of view, this is a huge benefit, since:

• It's more attractive for new people starting with development, since in future also apps should be added to Venus OS
• The build documentation gets easily outdated and is not updated. It gets also easily forgotten
• Before you needed to maintain the GitHub Actions script, which now is moved to these scripts. Therefore there is no additional work, but you need only to maintain other scripts. If they do not work anymore then you see that very fast under the GitHub Actions.

[DanielMcInnes]

I like the added convenience this brings to linux users, especially building and installing mqtt. I imagine similar scripts would be required for windows & mac users, resulting in 3 sets of build scripts that need to be maintained, which is not ideal. I think this would be better done via cmake, which would give you the same build behavior on all 3 platforms. See ExternalProject_Add at https://cmake.org/cmake/help/latest/module/ExternalProject.html . The downside of doing anything in cmake is the difficulty - it is often hugely frustrating.

For mqtt, you can do something like:

find_package(Qt6 Mqtt)
if qt6MqttNOTFOUND
ExternalProject_Add(....)
endif