Merge pull request #12 from Cyber-Syntax:refactor

- Add games installation support
- Improve borg backup script
- Update issue templates
- Improve logging

Author: Cyber-Syntax

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,43 +1,41 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: "bug: "
+title: "🐞 bug:   "
 labels: bug
 assignees: ""
 ---
 
-**Desktop (please complete the following information):**
+**Versions**
 
-- OS: [e.g. Linux Fedora]
-- Version [e.g. 0.4.3-beta]
-- Bash version [e.g 3.11]
+- fedora-setup version: <!-- e.g: 0.10.10-alpha -->
+- Python version: <!-- [e.g 3.12] -->
 
 **Describe the bug**
-A clear and concise description of what the bug is.
 
-**To Reproduce**
-Steps to reproduce the behavior:
+<!-- A clear and concise description of what the bug is. -->
 
-1. Started script 
-2. select choice 3
-3. See choice 1... 2..., select 2
-4. See this error:
+**Console Output**
 
-```bash
+<!-- Place to output in the below in the quotes -->
+
+```
 
 ```
 
 **Expected behavior**
-A clear and concise description of what you expected to happen.
 
-**5. ERROR LOG: logs/my-unicorn.log:**
+<!-- A clear and concise description of what you expected to happen. -->
+
+**LOG**
 
-````bash
+> Paste the log(`/home/<your_username>/.local/state/my-unicorn/my-unicorn.log`) here:
 
-```.
+```
 
 
+```
 
 **Additional context**
-Add any other context about the problem here.
-````
+
+<!-- Add any other context about the problem here. -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,17 +1,17 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: "feat: "
+title: "🚀 feat: "
 labels: enhancement
 assignees: ""
 ---
 
 **Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is.
-Ex. I'm always frustrated when [...]
+<!-- A clear and concise description of what the problem is. -->
+<!-- Ex. I'm always frustrated when [...] -->
 
 **Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+<!-- Clear and concise description of the solution you'd like to implement -->
 
 **Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+<!-- Clear and concise description of any alternative solutions or features you've considered. -->

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## v0.4.0-alpha
+### CHANGES
+New setups and improvements.
+
 ## v0.3.0-alpha
 ### CHANGES
 New setups and improvements.

README.md

@@ -58,7 +58,3 @@ Experimental: Below functions are need to tested with caution.
 Example:
 sudo $0 -a
 ```
-
-```
-
-```

configs/borg/README.md

@@ -2,10 +2,12 @@
 Description=Timer for Home Backup using BorgBackup
 
 [Timer]
-# Schedules the backup at 10:00 every day.
-OnCalendar=*-*-* 10:00:00
+# Schedules the backup at 07:00 every day.
+OnCalendar=*-*-* 07:00:00
+# Persistence will ensure the timer runs even if the system is down at the scheduled time.
 Persistent=true
-# Note: systemd timers work with local time. To follow Europe/Istanbul time, ensure your system’s timezone is set accordingly.
+# Note: systemd timers work with local time.
+# ensure your system’s timezone is set accordingly.
 
 [Install]
 WantedBy=timers.target

configs/borg/borgbackup-home.timer

@@ -1,15 +1,26 @@
-#!/bin/bash -e
-# Extract command
-# sudo borg extract --progress --list /mnt/backups/borgbackup/doc-repo::doc-27-02-2024
-#NOTE: this file need to be on /opt/borg/home-borgbackup.sh
+#!/usr/bin/env bash
+set -o errexit
+set -o nounset
+set -o pipefail
 
-export BORG_UKNOWN_UNENCRYPTED_REPO_ACCESS_IS_OK=yes
+# Check prerequisites
+command -v borg >/dev/null 2>&1 || {
+  echo >&2 "Borg is not installed. Please install it first."
+  exit 1
+}
+[[ -d /mnt/backups/borgbackup ]] || {
+  echo >&2 "Backup directory does not exist."
+  exit 1
+}
 
-REPOSITORY_home='/mnt/backups/borgbackup/home-nixos'
+export BORG_UNKNOWN_UNENCRYPTED_REPO_ACCESS_IS_OK=yes
 
-echo "Starting backup"
-# home
-sudo borg create --list --filter=AME --progress --stats --exclude-caches --show-rc \
+borg_home_repo='/mnt/backups/borgbackup/home-repo'
+
+echo "Starting backup for home"
+
+# --show-rc: if return 0 code, then it's successful
+if ! sudo borg create --list --filter=AME --progress --stats --exclude-caches --show-rc \
   --exclude /home/*/Documents/backup-for-cloud/ \
   --exclude /home/*/.cache/ \
   --exclude /home/*Downloads/ \
@@ -25,33 +36,38 @@ sudo borg create --list --filter=AME --progress --stats --exclude-caches --show-
   --exclude /home/*/.tox/ \
   --exclude /home/*/.venv/ \
   --exclude /home/*/.backups/ \
-  --compression zstd,15 $REPOSITORY_home::'{now:home-developer-%d-%m-%Y}' \
-  /home/developer/
+  --compression zstd,15 $borg_home_repo::'{now:home-developer-%d-%m-%Y}' \
+  /home/developer/; then
+  echo "Backup of home directory failed" >&2
+  exit 1
+fi
 
 echo "Backup of home directory complete"
 
-echo "Pruning old home backups"
-
-# --show-rc: if return 0 code, then it's successful
-sudo borg prune -v $REPOSITORY_home --list --stats --show-rc \
+if ! sudo borg prune -v $borg_home_repo --list --stats --show-rc \
   --keep-daily=7 \
   --keep-weekly=4 \
-  --keep-monthly=2
+  --keep-monthly=2; then
+  echo "Pruning of home backups failed" >&2
+  exit 1
+fi
+
+echo "Pruning of home backups complete"
 
-sudo borg check $REPOSITORY_home
-# after check
-echo "Check complete"
+if ! sudo borg check $borg_home_repo; then
+  echo "Check of home backups failed" >&2
+  exit 1
+fi
+echo "borg check completed successfully"
 
-# compact the repository to free up the space
-sudo borg compact $REPOSITORY_home
+if ! sudo borg compact $borg_home_repo; then
+  echo "Compaction of home backups failed" >&2
+  exit 1
+fi
 
 echo "Compaction complete"
-# make sure to sync
+
+# Being paronoid here
 sync
 
-# if return = 'rc 0' then it's successful
-if [ $? -eq 0 ]; then
-  echo "Backup and prune complete!"
-else
-  echo "Backup and prune failed!"
-fi
+echo "Borg backup completed successfully"

configs/borg/home-borgbackup.sh

@@ -124,6 +124,7 @@ needs_dnf_speedup() {
     $install_system_specific_packages_option ||
     $install_app_packages_option ||
     $install_dev_packages_option ||
+    $install_games_packages_option ||
     $librewolf_option ||
     $qtile_option ||
     $brave_option ||
@@ -226,6 +227,16 @@ install_dev_packages() {
   log_info "Development packages installation completed."
 }
 
+install_games_packages() {
+  log_info "Installing games..."
+  if ! sudo dnf install -y "${GAMES_PACKAGES[@]}"; then
+    log_error "Error: Failed to install games." >&2
+    return 1
+  fi
+
+  log_info "Games installation completed."
+}
+
 install_flatpak_packages() {
   log_info "Installing Flatpak packages..."
 
@@ -358,6 +369,7 @@ main() {
   install_system_specific_packages_option=false
   install_app_packages_option=false
   install_dev_packages_option=false
+  install_games_packages_option=false
   flatpak_option=false
   librewolf_option=false
   qtile_option=false
@@ -395,11 +407,12 @@ main() {
   nfancurve_option=false
 
   # Process command-line options.
-  while getopts "abBcdDEFfghHIiAalLjnNopPrstTuUvVzqQxCMSX" opt; do
+  while getopts "abBcdDEFfGghHIiAalLjnNopPrstTuUvVzqQxCMSX" opt; do
     case $opt in
       a) all_option=true ;;
       A) install_app_packages_option=true ;;
       D) install_dev_packages_option=true ;;
+      G) install_games_packages_option=true ;;
       b) brave_option=true ;;
       B) borgbackup_option=true ;;
       c) touchpad_option=true ;;
@@ -446,6 +459,7 @@ main() {
     [[ "$install_system_specific_packages_option" == "false" ]] &&
     [[ "$install_app_packages_option" == "false" ]] &&
     [[ "$install_dev_packages_option" == "false" ]] &&
+    [[ "$install_games_packages_option" == "false" ]] &&
     [[ "$flatpak_option" == "false" ]] &&
     [[ "$borgbackup_option" == "false" ]] &&
     [[ "$touchpad_option" == "false" ]] &&
@@ -521,6 +535,7 @@ main() {
     install_core_packages
     install_app_packages
     install_dev_packages
+    install_games_packages
     install_system_specific_packages "$system_type"
 
     # System-specific additional functions.
@@ -569,6 +584,7 @@ main() {
     if $install_core_packages_option; then install_core_packages; fi
     if $install_app_packages_option; then install_app_packages; fi
     if $install_dev_packages_option; then install_dev_packages; fi
+    if $install_games_packages_option; then install_games_packages; fi
     if $install_system_specific_packages_option; then install_system_specific_packages "$system_type"; fi
     if $touchpad_option; then touchpad_setup; fi
     if $flatpak_option; then install_flatpak_packages; fi

setup.sh

@@ -319,6 +319,7 @@ parse_json() {
 # Purpose: Create default packages.json configuration file
 # Arguments: $1 - Output file path
 # Returns: 0 on success, 1 on failure
+#TODO: Make function to install games too.
 create_default_packages_json() {
   local output_file="$1"
 
@@ -347,9 +348,21 @@ create_default_packages_json() {
     "neovim",
     "vim",
     "pavucontrol",
-    "chromium"
+    "chromium",
+    "gimp",
   ],
   "dev": [
+    "gparted",
+    "kernel-tools",
+    "kdiskmark",
+    "gitleaks",
+    "stow",
+    "clamav",
+    "freshclam",
+    "libsecret",
+    "libsecret-devel",
+    "gnome-screenshot",
+    "openssh-askpass",
     "papirus-icon-theme",
     "git-credential-libsecret",
     "gh",
@@ -373,6 +386,7 @@ create_default_packages_json() {
     "yarnpkg",
     "bash-language-server",
     "python3-devel",
+    "python3-tkinter",
     "dbus-devel",
     "shfmt",
     "ShellCheck"
@@ -411,6 +425,14 @@ create_default_packages_json() {
     "playerctl",
     "xev"
   ],
+  "games": [
+    "wine",
+    "wine-mono",
+    "winetricks",
+    "lutris",
+    "steam",
+    "heroic-games-launcher-bin"
+  ],
   "flatpak": [
     "org.signal.Signal",
     "io.github.martchus.syncthingtray",
@@ -954,6 +976,7 @@ load_package_arrays() {
   CORE_PACKAGES=($(parse_json "$packages_file" ".core[]"))
   APPS_PACKAGES=($(parse_json "$packages_file" ".apps[]"))
   DEV_PACKAGES=($(parse_json "$packages_file" ".dev[]"))
+  GAMES_PACKAGES=($(parse_json "$packages_file" ".games[]"))
   DESKTOP_PACKAGES=($(parse_json "$packages_file" ".desktop[]"))
   LAPTOP_PACKAGES=($(parse_json "$packages_file" ".laptop[]"))
   QTILE_PACKAGES=($(parse_json "$packages_file" ".qtile[]"))
@@ -1073,6 +1096,7 @@ init_config() {
   log_info "Qtile Packages: ${#QTILE_PACKAGES[@]} packages"
   log_info "Flatpak Packages: ${#FLATPAK_PACKAGES[@]} packages"
   log_info "Development Packages: ${#DEV_PACKAGES[@]} packages"
+  log_info "Games Packages: ${#GAMES_PACKAGES[@]} packages"
   log_info "Desktop Packages: ${#DESKTOP_PACKAGES[@]} packages"
   log_info "Laptop Packages: ${#LAPTOP_PACKAGES[@]} packages"
   log_info "===== End of Summary ====="

src/config.sh

@@ -343,6 +343,13 @@ lightdm_autologin() {
     # Write the new content to the file
     echo -e "$new_content" | sudo tee "$conf_file" >/dev/null
   fi
+  # pam setup for auto unlock gnome keyring
+  #TODO: handle this later
+  #NOTE: this isn't work with autologin because its need password on from display manager
+  #   # Gnome keyring auto unlock
+  # auth       optional     pam_gnome_keyring.so
+  # session    optional     pam_gnome_keyring.so auto_start
+  #
 
   log_success "LightDM autologin configuration completed"
   return 0