Local development, contribution guide and remote branch change to test code.

cusspvz commented 2 months ago

Description

First of all congratulations on building this project, it is extremely useful and I've been using it on personal stuff.

It wasn't clear how I could test changes before making my first contribution, so I decided to make a few changes to develop some installation scripts and test these before I create a PR.

My changes makes it easier for contributors to test changes before pushing a PR, and for the reviewers of the PRs to test them before they land onto the main branch.

Type of change

Please check the relevant option(s):

[x] Scripting: Added a fs.func as the main loader helper so all the other loaders refer to the fs_ methods to gather other resources. This file includes a fs_cat function that, depending on the configuration, could gather the files from the local file system, or from the GitHub raw content endpoint. On the latter, it can also allow the user to change the reference to a different commit or branch other than main.
[x] Scripting/Experience: the default experience should always be using the remote and main branch. If any of these change for some reason, the user will be alerted and prompted to confirm that they wish to proceed.
[x] Changed all the installation files to load the fs.func instead of the build.func file first, and then the build.func file gets loaded by the fs_cat helper function.
[x] Documentation: Added a CONTRIBUTING.md file
[x] File permissions: executed find . -name "*.sh" -type f -exec chmod +x {} + to make all the .sh files executable so contributors could run these locally.
[x] Moved create_lxc.sh to the misc/ folder, as it seemed the proper folder for it to be at.

Test these changes

Clone the repository and branch to your Proxmox host, and set the PHS_ROOT to your cwd.

export PHS_ROOT=$(pwd)

Edit the initial URL of any file and point it towards the latest commit of this PR.

Example:

 #!/usr/bin/env bash
-source <(curl -s https://raw.githubusercontent.com/tteck/Proxmox/main/misc/fs.func)
+source <(curl -s https://raw.githubusercontent.com/cusspvz/Proxmox-Helper-Scripts/42e1308d/misc/fs.func)

Execute the edited script.

Example:

./ct/alpine-grafana.sh

tteck commented 2 months ago

Thank you for the pull request! I really appreciate the effort you put into it, but I’m not interested in merging this at the moment.

matbgn commented 2 months ago

Hi @tteck

Sorry to jump in but could you please, in this particular case, give a context to your refusal? Because for a end user perspective this PR improve dramatically the quality of all the chain of code and therefore ensure a kind of protection to supply chain attack because we could enhance further tests and then run them locally. Or do I miss something?

tteck / Proxmox