doc: add .gitea/PULL_REQUEST_TEMPLATE.md, xsrv: add functions descrip…

…tions
MickaelGuilloux · May 6, 2021 · 6ba272d · 6ba272d
1 parent 226dc83
commit 6ba272d
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/.gitea/PULL_REQUEST_TEMPLATE.md b/.gitea/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1 @@
+- [ ] CHANGELOG.md updated
diff --git a/xsrv b/xsrv
@@ -204,6 +204,7 @@ function init_host() {
         echo "[xsrv] ERROR: $playbook_dir/host_vars/$host_name already exists"; exit 1
     fi
     # TODO move inventory creation to init_playbook(), only handle adding a single host here
+    # TODO cleaup
     if [[ ! -f "$playbook_dir/inventory.yml" ]]; then
         echo "[xsrv] INFO: creating inventory for $playbook_name"
         sed "s/my.example.org/$host_name/g" "$templates_dir/playbooks/xsrv/inventory.yml" >> "$playbook_dir/inventory.yml"
@@ -271,6 +272,7 @@ function upgrade_roles() {
 }
 
 function show_defaults() {
+    # show all role defaults, accepts a role name
     check_playbook_exists
     role=${2:-}
     if ! hash "${pager%% *}" 2>/dev/null; then
@@ -291,6 +293,7 @@ function show_defaults() {
 }
 
 function self_upgrade() {
+    # upgrade the running xsrv scrip in-place
     script_path="$0"
     echo "[xsrv] INFO fetching latest release..."
     if [[ -d "$xsrv_clone_dir/.git" ]]; then